Pull Requests¶

Creating a GitHub Pull Request¶

Once you have finished working on the issue and your work is ready to be released, you can push your local changes to your branch, and then make a pull request on the GitHub repository's web page. To make the pull request, click on the "Pull requests" within the repository, and then select "New pull request". Now, select the branch you wish to merge. Once you've finished comparing changes, click "Create pull request" and complete the pull request form detailing all the changes that you've made. Once the form is completed, you can assign a reviewer on the right side before creating the pull request.

Creating Pull Request

Do not merge the pull request yourself!

Allow at least one other member of the repository to review your pull request, and hav ethem merge it into main.

Once your changes have been merged with the main branch of the repository, please delete the branch in order to keep the repository clean.

Deleting Branch

Creating a Pull Request Template¶

Within the .github directory of your repository, click "Add file", then "Create new file".
Name the file PULL_REQUEST_TEMPLATE.md.
In the text box below, enter your Markdown formatted pull request template - see below for an example.
Finally, scroll down, complete the description and press "Commit new file".

Example PR template

### Description
Please include a summary of the changes, and any relevant context and depedencies.
_Linked issue_: #

### Type of change
Please check the relevant option(s).
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
- [ ] 🌟 New feature (non-breaking change which adds functionality)
- [ ] 🛑 Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] 📝 This change requires a documentation update

### Please check if the PR fulfills these requirements:
- [ ] My code follows the style guidelines of this project
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] I have added/updated tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes

### Does this pull request introduce breaking changes?
No | Yes, the breaking changes are as following: