Pull Requests

Procedure for submitting and merging PRs (pull requests).

• Create a pull request
  • The title of the PR becomes the commit message in the main branch, so be as concise and specific as possible
  • Try to limit to 300 lines of code changes; smaller logical chunks of code is better; https://blog.logrocket.com/using-stacked-pull-requests-in-github/
  • https://opensource.com/article/18/6/anatomy-perfect-pull-request
  • https://developers.google.com/blockly/guides/modify/contribute/write_a_good_pr
• Add reviewers or post in Slack channel #benefits-virtual-regional-office for anyone to review
• Add comments to your code under the "Files Changed" tab to explain complex logic or code
  • https://betterprogramming.pub/how-to-make-a-perfect-pull-request-3578fb4c112
• Reviewers provide feedback, clearly marking blocking and non-blocking suggestions
  • https://github.blog/2015-01-21-how-to-write-the-perfect-pull-request/
• Address feedback and repeat review step until PR is approved
• Squash and merge PR, which will trigger Github-Actions#mirror among other things