Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Respect People's Time

  2. Always Provide Constructive Feedback

  3. Keep Your Ego Out of Code Reviews

    1. Reasons not feelings

    2. Be open to other ways of doing things

  4. Be Precise About What Needs to be Improved

  5. Don't Just Hope for the Code to Work

  6. Reinforce Code Submission Best Practices

  7. Be Strict About Temporary Code

  8. Check the Project’s Satellite Files (documentation, etc)

  9. Visualize the Bigger Picture

  10. Title the Pull Requests clearly, linking to the original JIRA issue if possible

    1. For example: PROJ-123: Description

  11. 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:

    1. This change turns the button color GREEN, because RED wasn’t very user friendly.### References-

      Jira Legacy
      serverSystem JIRA
      serverId41d68d07-61a5-32f6-8aef-2e24159645c2
      keyPROJ-123

  12. 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; ```

Image Added

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.

...