-
Notifications
You must be signed in to change notification settings - Fork 1
Contribution documentation
Clare Walsh edited this page Jun 4, 2021
·
5 revisions
- Clone the repo.
- Find an issue that isn't in progress.
- Ask any questions (for clarification or explanation) on the issue, so that they can be seen. If it's code related tag @blaise17 or @psi77. If it's requirements related tag @joereddington. Include your design choices and reasoning on the issue to make the PR process faster and easier.
- Remember you are not the target user.
- Make a branch of the format
<yourname>/issue#<issueno>/<description>
and move the issue to in progress, assigning yourself. - Make the code changes required INCLUDING TESTS. PRs without tests will not be approved.
- Submit a PR to develop, including "Closes #" in the description.
- Make sure the checks pass, if they don't find out why and fix them.
- Request a review from either @blaise17 or @psi77 or both.
- Make any required changes from reviews.
- Squash and merge your PR into develop once it has been approved and has passed the checks. We use squash and merge here so that develop only ever contains working commits.
- Check the staging deployment works as expected.
- Rejoice. You've made the world a better place.
- Create a PR from develop to master.
- Make sure the checks pass, if they don't find out why and fix them.
- Request a review from @joereddington and either @blaise17 or @psi77.
- Merge the PR into master once it has been approved and has passed the checks. We use merge here so that master contains all the commits contained on develop.
- Create a PR from master to develop to bring the stupid merge commit back and make develop up to date.
- Make sure the checks pass, if they don't find out why and fix them.
- Request a review from either @blaise17 or @psi77 or both.
- Merge the PR into develop once it has been approved and has passed the checks. We use merge here so that develop knows it's up to date with master and has the same commit.
- Check the live deployment works as expected.
- Rejoice. YOu've made the world a better place.