...
Respect People's Time
Always Provide Constructive Feedback
Keep Your Ego Out of Code Reviews
Reasons not feelings
Be open to other ways of doing things
Be Precise About What Needs to be Improved
Don't Just Hope for the Code to Work
Reinforce Code Submission Best Practices
Be Strict About Temporary Code
Check the Project’s Satellite Files (documentation, etc)
Visualize the Bigger Picture
Title the Pull Requests clearly, linking to the original JIRA issue if possible
For example: PROJ-123: Description
Provide a clear description of what is accomplished with the code change in the Pull Request, and link to the original JIRA issue when possible. For example:
This change turns the button color GREEN, because RED wasn’t very user friendly.### References-
Jira Legacy server System JIRA serverId 41d68d07-61a5-32f6-8aef-2e24159645c2 key PROJ-123
For small 1-5 line inline changes use GitHub’s inline comments feature, along with inline suggestions. For example… The button size should be 5 instead of 3. ``` suggestion $buttonSize = 5; ```
To Consider
When is a PR appropriate
Who is responsible for resolving merge conflicts
Goal of knowledge sharing as much as “approval”
How to prioritize/review style guide issues
Be generous of spirit – the goal is to produce code that works for functional web sites.
...