Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add code review advice #243

Merged
merged 4 commits into from
Nov 9, 2024
Merged

Add code review advice #243

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ffb8b61
Added code review advice.
david-waltermire Nov 9, 2024
98a1468
Apply suggestions from code review
david-waltermire Nov 9, 2024
1e67479
More abstract GHA logic into environment variables. Fixed unknown use…
david-waltermire Nov 9, 2024
f8ff88a
Using static git user and email.
david-waltermire Nov 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,26 @@ Each project card will be in one of the following states:

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.

## Code Review

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).

The following are some guidelines to consider when performing code reviews.

- Tone
- Do ask open-ended questions and avoid making opinionated statements.
- Do keep feedback positive. Consider the effort the author spent writing the PR. Celebrate good work.
- Do differentiate between nits and suggestions vs blocking feedback. Limit nits. Use [Conventional Comments](https://conventionalcomments.org) to the greatest extent possible.
- Do consider how your feedback could be addressed by follow-on work. Consider opening new issues for less significant concerns.
- Unit Testing
- Do consider the coverage of test cases. Do the unit tests cover major code paths and error conditions?
- Approving or Requesting changes
- Do not approve or request changes to a PR if you have open questions. Seek question resolution before taking a position.
- Do not request changes for a nit or suggestion.
- Do not strive for perfect. Does the PR improve the code health overall?
- Resolving Conversations
- Do mark your feedback as resolved when it has been addressed.

## Communications mechanisms

You can contact the maintainers of this project at [[email protected]](mailto:[email protected]) if you are interested in contributing to the development of this project or exchanging ideas.
Expand Down
Loading