Pull Request Template
Pull Request
- Push the code on GitHub.
- Click on the
Compare & pull request button to create a PR.
Description
- Describe the purpose and context of the changes made in this PR.
- Add screenshots that clarify the implemented feature, fixed bug etc.
- Add links to related issues using the format #123.
Checklist
- [ ] I have tested the changes.
- [ ] I have updated the documentation if needed.
- [ ] My code follows the project's coding standards.
- [ ] I have added unit tests if applicable.
Add Reviewer
- Assign one or more reviewers to the Pull Request.
- Reviewers provide feedback and approve changes before merging.
- Select individuals with expertise in the code affected by the PR.
Assign to Self
- Assign the Pull Request to yourself to indicate that you are responsible for it.
- Taking ownership helps in tracking the progress of the PR.
Add Label
- Apply relevant labels to categorise the Pull Request.
- Labels can indicate the type of change (e.g., feature, bug fix).
Add Project
- Associate the Pull Request with a project board if applicable.
- Projects help organise and track the progress of related tasks.
- Choose status (e.g., in progress, ready for review).