prguidance

Pull Request Review Guidelines

A reviewer should examine the PR once the ready label has been added.

Once ready, the reviewer should read the information below as well as supporting information like the Azure DevOps ticket to ensure they have a good understanding of the request.

Items to Review

• The PR template is complete and accurate.

• The PR is set to merge into the appropriate branch.

  • Task branches should generally merge into a feature branch for the user story. Feature branches should merge into dev once all tasks are completed. Bugs should merge into the dev branch. Exceptions for hotfixes and end-of-sprint merges do occur and the target would then be master.

• The commit messages appropriately describe the changes and link to the relevant Azure DevOps ticket by including a reference to "AB#nnnnn".

• The changes fulfill the story's acceptance criteria or resolve the issue identified in the bug report on Azure DevOps, as appropriate.

  • Changes not directly related to the task requirements need to be documented on the PR and on the Azure DevOps ticket.

• The changes do not break compilation and/or unit or functional tests, unless other work items exist to address these specifically.

• The changes work as intended and do not introduce problems.

• The changes do not introduce obvious performance issues.

• The changes adhere to the team's documented Coding Standards.

• The changes are well-documented and match the style of other similar work.

• The changes can be easily understood and allow for future enhancements without major refactoring.

  • Readability is preferred over "clever code".

• The reasoning for changes is clearly articulated.

  • Disagreements should be arbitrated by a third developer.

If the pull request does not meet these criteria, the reviewer should request changes.