Skip to content

Commit 31c9c08

Browse files
Added code review advice.
1 parent f137c53 commit 31c9c08

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,26 @@ Each project card will be in one of the following states:
6969

7070
Note: One or more pull requests must be submitted addressing all user story goals before the issue will be moved to the "under review" status. If any goals or acceptance criteria have not been met, then the user story will be commented on to provide feedback, and the issue will be returned to the "In progress" state.
7171

72+
## Code Review
73+
74+
Contributors are encouraged to [review PRs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).
75+
76+
The following are some guidelines to consider when performing code reviews.
77+
78+
- Tone
79+
- Do ask open-ended questions and avoid making opinionated statements.
80+
- Do keep feedback positive. Consider the effort the author spent writing the PR. Celebrate good work.
81+
- Do differentiate between nits and suggestions vs blocking feedback. Limit nits.
82+
- Do consider how your feedback could be addressed by follow-on work. Consider opening new issues for less significant concerns.
83+
- Unit Testing
84+
- Do consider the coverage of test cases. Do the unit tests cover major code paths and error conditions?
85+
- Approving or Requesting changes
86+
- Do not approve or request changes to a PR if you have open questions. Seek question resolution before taking a position.
87+
- Do not request changes for a nit or suggestion.
88+
- Do not strive for perfect. Does the PR improve the code health overall?
89+
- Resolving Conversations
90+
- Do mark your feedback as resolved when it has been addressed.
91+
7292
## Communications mechanisms
7393

7494
You can contact the maintainers of this project at [maintainers@metaschema.dev](mailto:maintainers@metaschema.dev) if you are interested in contributing to the development of this project or exchanging ideas.

0 commit comments

Comments
 (0)