Pull Request Standards and Processes

Pull Request Template Content

For most projects, we have implemented a Planet Argon specific Pull Request Template in order to unify the experience of reviews and provide necessary context to Pull Requests. Pull Requests are often used for historical purposes - so any context helps!

Tips for Good PR content

• In the “Changes proposed by this PR” section, bullet point a few key changes with specific areas that have been impacted
• Sometimes a picture is enough to explain the issue being fixed
• In the “How to see these changes” section, it is helpful to include directions or links. Pretend as if the reviewer has only a basic familiarity with the site being reviewed.

Here is an example:

Stoplight System for PR Reviews

For PR Authors:

• When your pull request (PR) is ready for review, announce it in the relevant Slack channel with an @here tag, including the PR link.
• Example: @here this PR is ready for review: [ link URL ]

For Potential Reviewers:

• React to the PR post with a :green-light: if you can review it immediately.
• React to the PR post with a :yellow-light: if you are available to review it later.
• React to the PR post with a :red-light: if you are unable to review it that day.
  • Note: If you react with a :yellow-light: but another reviewer uses a :green-light:, the :green-light: reviewer has priority.
• After completing the review, react with a :white_check_mark: and leave a comment to inform the PR author whether the PR is approved or if you have left feedback on the PR.

For PR Authors:

Once your PR is merged, mark it with a :merged: emoji.

Additional Guidelines:

• Feel free to ask questions about this process; it’s designed to keep our projects moving smoothly.
• Anyone is welcome to review any PR, which encourages diverse feedback and learning.
• If you have a specific reviewer in mind, you can tag them directly. However, this should not prevent others from reviewing and commenting.
• This system ensures timely and efficient PR reviews, making our team collaboration more effective. Happy reviewing! 🎉

---

The following still needs to be written/revised PR guidelines

code review VS PR review

team review assignments

• uses team auto assignment https://docs.github.com/en/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team#about-auto-assignment

SEM assignments

• uses CODEOWNER https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners