This PR will add a template to all PRs created in this repo. How it looks is shown below, you should do these steps:
[ ] If you're using workflow, then remove the non-workflow checks. Otherwise, remove the workflow checks
[ ] Add custom checks for your repo to the custom check section, or delete that section
[ ] If you use sol already, delete the contributing section from the workflow.json file.
This is a non-functional change, and should have no impact on your apps' functionality. It also probably does not need a version bump / changelog bump, as it does not need to be deployed and can just carry along w/ other changes. (this could technically be merged in on red - but that's up to you and your team)
Note This is for your benefit :). If this is too cumbersome, and not useful - you should change it! This is a suggested starting point for you, based off of things that sound good to people who aren't making pull requests against your repo every day. If you just need one box that says "Yes, this was code reviewed" - Then delete everything from the file, and add that! This is supposed to make things easier, and help you. Not make things harder!
Example of how this would look for every PR
Summary
{Include information about what is being done in this merge and why. This should be easy to read.}
PR - Merge Checklist:
[ ] CR'd
[ ] Workflow: Title has semver bump level defined (#major, #minor, or #patch)
[ ] Non Workflow: Version file has been updated
[ ] Non Workflow: Changelog file has been updated
[ ] README updated or N/A
[ ] Dependencies satisfied or N/A {db-schema,upstream repos,chef,config,hardware,ops - Add bullet points with links to corresponding PRs/tickets}
[ ] Acceptance criteria verified by QE
[ ] Fully tested and approved by QE
Custom Repo Checklist:
[ ] Replace this with repo specific checks
Dependencies:
[ ] {db-schema/db,upstream repos —> integration - Add bullet points with links to corresponding PRs/tickets}
Risks:
{Risks that are associated with this merge. Things that it could possibly take down in production if released.}
{NOTE: There is always some sort of Risk, don't leave this section blank!}
This PR will add a template to all PRs created in this repo. How it looks is shown below, you should do these steps:
This is a non-functional change, and should have no impact on your apps' functionality. It also probably does not need a version bump / changelog bump, as it does not need to be deployed and can just carry along w/ other changes. (this could technically be merged in on red - but that's up to you and your team)
Note This is for your benefit :). If this is too cumbersome, and not useful - you should change it! This is a suggested starting point for you, based off of things that sound good to people who aren't making pull requests against your repo every day. If you just need one box that says "Yes, this was code reviewed" - Then delete everything from the file, and add that! This is supposed to make things easier, and help you. Not make things harder!
Example of how this would look for every PR
Summary
{Include information about what is being done in this merge and why. This should be easy to read.}
PR - Merge Checklist:
Custom Repo Checklist:
Dependencies:
Risks:
{Risks that are associated with this merge. Things that it could possibly take down in production if released.} {NOTE: There is always some sort of Risk, don't leave this section blank!}
Rollback:
{How do you roll this back if it fails?}