Development process
Step 3: Create the Pull Request
Navigate to the GitHub repository page for Tribe of the Accord, and you'll see an option to "Compare & pull request" for your branch. Click on it to begin creating your pull request.
Pull Request Template
The project provides a PR template to guide you through providing all necessary information about your changes. Here's how to use it:
- Description: Provide a brief overview of the changes or features introduced. Include specific file paths or components affected if possible.
- Related Issue(s): Link the Notion ticket this maps to. Every PR should have an associated Notion ticket from the Tribe of the Accord Kanban board. This helps with project tracking and makes sure that we are prioritising the right work.
- Type of Change: Indicate whether this is a bug fix, new feature, enhancement, documentation update, etc. using the labels.
- Testing Done: Describe any testing you performed to ensure the changes work as expected. This includes manual Smoke testing and GUT automated testing. You should ensure no regressions are introduced with your changes, and if so, create tests to cover it not happening again.
- Checklist: Sanity check of all the steps required, and acknowledgement that once the PR is merged to main it will get automatically tagged with a semantic version.
- Screenshots/GIFs/Videos: If applicable, add visuals to help showcase the changes.
- Additional Notes: Add any other details or notes helpful for reviewers.
- Reviewer(s): Tag specific individuals or teams for reviewing your PR if they should be aware of changes you are doing (e.g. crossover).
- Merge Readiness: Indicate if the PR is ready for merging or if any work remains to be done.
Ideally I'd use Draft Pull Requests, but this is an Enterprise feature and the cost isn't justified. What you can do instead if prefix your PR with 'WIP -' and remove once it is ready.