Skip to content

Commit a9190fd

Browse files
authored
More details about best practices (openhwgroup#2997)
Here are a few details about our current practices.
1 parent 92b2d0b commit a9190fd

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Therefore here are guidelines to help the CVA6 team accept new contributions:
1616

1717
- Get in touch early with the CVA6 team, present your initiative, get feedback, synchronize with the team...
1818
* The CVA6 team wants to assess the potential of your contribution.
19+
* The CVA6 team plans the next evolutions, and your contributions could be incompatible with them.
1920
* The CVA6 team can provide you recommendations to ease the upcoming contribution.
2021
* This can help save significant review and overhauling effort for you and us when dealing with the pull request review.
2122
* Together, we can anticipate specific cases that are not addressed here.
@@ -50,6 +51,10 @@ Therefore here are guidelines to help the CVA6 team accept new contributions:
5051
- So that we can detect quickly if future updates break your contribution.
5152
- To avoid impacting those users who use your contribution in their project.
5253
- At this point, we do not request a 100%-coverage verification suite.
54+
* Be kind to the people who process your pull request(s)
55+
- Explain your contribution in the pull request.
56+
- If your contribution solves an issue, fill in an issue and cross link it in the pull-request.
57+
- The reviewer(s) prefer to review several small pull requests rather one large pull request. Synchronize with the team to identify the right breakdown.
5358

5459
If you encounter difficulties with these guidelines, get in touch with the team!
5560

0 commit comments

Comments
 (0)