code review documentation

[ericbuckley]

Pull Request

Description

This PR aims to initiate a discussion to standardize our code review process, with the intention of incorporating agreed-upon artifacts to provide guidance for the team in the future.

Additional Notes

The content herein is not meant to be definitive or anywhere near our team's desired outcome. Rather, it serves as an initial framework, incorporating widely-used boilerplate definitions available online, along with some insights drawn from my past team experiences.

If anyone finds this initial framework too opinionated or inflexible, please let your lead(s) know. Starting over is always an option.

The documents within are as follows:

• .github/pull_request_template.md: A checklist template that will be used for all future pull requests, aiming to maintain consistency for both author(s) and reviewer(s).
• REVIEW_GUIDELINES.md: A collection of guidelines, emphasizing flexibility rather than rules, outlining how reviews should be conducted. While the first rule, "Be Respectful," is non-negotiable, the rest are meant to be considered as guiding principles rather than inflexible mandates. Exceptions may apply to most of these guidelines at certain times.
• REVIEW_SLAS.md: A collection of anticipated procedures detailing the typical review process and agreements our team seeks to establish, fostering clear expectations between authors and reviewers.

Checklist

Please review and complete the following checklist before submitting your pull request:

• [x] I have ensured that the pull request is of a manageable size, allowing it to be reviewed within a single session.
• [x] I have reviewed my changes to ensure they are clear, concise, and well-documented.
• [x] I have updated the documentation, if applicable.
• [ ] I have added or updated test cases to cover my changes, if applicable.
• [x] I have minimized the number of reviewers to include only those essential for the review.
• [ ] I have notified teammates in the review thread to build awareness.

Checklist for Reviewers

Please review and complete the following checklist during the review process:

• [ ] The code follows best practices and conventions.
• [ ] The changes implement the desired functionality or fix the reported issue.
• [ ] The tests cover the new changes and pass successfully.
• [ ] Any potential edge cases or error scenarios have been considered.

cc @zdeveloper @jonchang @colekettler @arinkulshi-skylight @knguyenrise8 @bryanbritten @alhayward @cbrinson-rise8 @derekadombek

[ericbuckley]

@zdeveloper to add some additional context... In our dedupe check-in today, we discussed starting this process. The idea was to include the OCR team as well, as the teams are sharing this repo and will likely collaborate on future endeavors. If you prefer having two processes, one for dedupe and another for OCR, please let @bryanbritten know.

[ericbuckley]

@jonchang @colekettler @arinkulshi-skylight @knguyenrise8 @alhayward @cbrinson-rise8 @derekadombek even though I didn't explicitly tag you as reviewers in this PR, I highly value your input and ideas. Therefore, if you have the time, I encourage you to read these documents and share your thoughts.

[alhayward]

Looks great! Thanks for putting this together!