Deploying Changes / Code Review
- Pulls Dashboard
- GitHub
- Every Pull Request should be code-reviewed before being merged.
- When a developer is ready to have their Pull Request reviewed, they should add the label
review-neededto the Pull Request. - Any developer can review another's Pull Request, but the responsibility for code-review falls to the Project Maintainer; and it is their responsibility to oversee the architecture and integrity of the project's codebase.
- When reviewing a Pull Request, your goals should be:
- to spot bugs
- to evaluate whether the Pull Request would be hot compatible or not
- to understand the intention of the code
- to see whether the code's style, architecture, or idioms fits with the conventions of the rest of the codebase
- to make recommendations if the code could communicate more clearly or be structured more cleanly
- After reviewing a Pull Request, remove the
review-neededlabel and add:review-passif the Pull Request can be deployed with no further workreview-pass+suggestionsif the Pull Request is OK to be deployed, but you've made suggestions for the committer to considerreview-pass+holdif the Pull Request is OK to be deployed, but it should be held until another Pull Request is merged — or until a scheduled maintenance window. (Add a comment explaining the conditions for thehold)review-holdif you've asked questions that committer should answer or identified things that the committer should resolve before the Pull Request can be merged