GitHub Pull Requests
Info
This page is in progress...
Pull requests are used to submit code changes in GitHub; having a standard way to submit pull requests is beneficial in many ways.
Items required before submitting the pull request¶
The following items are required before submitting the pull request:
- A very clear and concise title
- The why is this PR happening? What is it fixing or improving?
- Describe the big picture of your changes here to communicate to the maintainers why this pull request should be accepted.
- Proper label - Select the
type:
label that best describes the changes
A very clear and concise title¶
This should be self-explanatory.
Why are you opening the pull request?¶
This should address the following:
- What are the proposed changes?
- In your own words, describe the big picture of your changes here.
Adding the proper type:
label¶
Select only one of the proper type:
label that best describes the changes being made.