Update PR Template and example version on issue templates (#2418)
parent
02e8af8559
commit
5d9df4e566
@ -1,24 +1,63 @@
|
||||
## Description
|
||||
|
||||
Please include a summary of the changes.
|
||||
|
||||
### Issues Fixed or Closed
|
||||
|
||||
- Fixes #(issue)
|
||||
|
||||
## Type of Change
|
||||
<!--
|
||||
For Work In Progress Pull Requests, please use the Draft PR feature,
|
||||
see https://github.blog/2019-02-14-introducing-draft-pull-requests/ for further details.
|
||||
|
||||
For a timely review/response, please avoid force-pushing additional
|
||||
commits if your PR already received reviews or comments.
|
||||
|
||||
Before submitting a Pull Request, please ensure you've done the following:
|
||||
- ✅ Test your changes locally to prove they work prior to submitting PRs.
|
||||
- 👷♀️ Create small PRs. In most cases this will be possible.
|
||||
- 📝 Use descriptive commit messages.
|
||||
- 📗 Update the CHANGELOG and Documentation where necessary.
|
||||
-->
|
||||
|
||||
## What type of PR is this?
|
||||
|
||||
<!--
|
||||
Type X in the brackets of any relevant option, for example:
|
||||
- [X] Bug Fix (non-breaking change which fixes an issue)
|
||||
-->
|
||||
- [] Bug Fix (non-breaking change which fixes an issue)
|
||||
- [] Feature/Tweak (non-breaking change which adds new functionality or enhances existing functionality)
|
||||
- [] Breaking Change (fix or feature that would break any existing functionality for users)
|
||||
- [] Documentation Update
|
||||
- [] Other
|
||||
|
||||
Please delete options that are not relevant.
|
||||
|
||||
- [] 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)
|
||||
- [] Documentation change (non-code changes affecting only the wiki)
|
||||
- [] Infrastructure change (changes related to the github repo, build process, or the like)
|
||||
|
||||
## Checklist
|
||||
|
||||
Please delete options that are not relevant.
|
||||
## Description
|
||||
|
||||
- [] Updated Documentation to reflect changes
|
||||
- [] Updated the CHANGELOG with the changes
|
||||
_Please replace this line with a meaningful description of your PR. What does it do? Why? Has it been tested? What were the results?_
|
||||
|
||||
## Related Issues [optional]
|
||||
|
||||
<!--
|
||||
For pull requests that relate or close an issue, please include them below.
|
||||
We like to follow [Github's guidance on linking issues to pull requests](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
|
||||
|
||||
For example having the text: "closes #1234" would connect the current pull request to issue 1234.
|
||||
And when the merged pull request reaches the master branch, Github will automatically close the issue.
|
||||
-->
|
||||
- Related Issue #
|
||||
- Closes #
|
||||
|
||||
## Have you updated the Documentation to reflect changes (if necessary)?
|
||||
|
||||
<!--
|
||||
If your PR warrants Documentation changes, you are expected to make the relevant changes.
|
||||
Failure to do so will result in your PR not being approved.
|
||||
Type X in the brackets of any relevant option, for example:
|
||||
- [X] Yes
|
||||
-->
|
||||
- [] Yes
|
||||
- [] No
|
||||
|
||||
## Have you updated the CHANGELOG?
|
||||
|
||||
<!--
|
||||
Any PR that goes beyond a minor tweak (i.e. replacing a value, fixing a typo) should have a CHANGELOG entry.
|
||||
We may ask you to update the CHANGELOG if you haven't done so.
|
||||
Type X in the brackets of any relevant option, for example:
|
||||
- [X] Ye
|
||||
-->
|
||||
- [] Yes
|
||||
- [] No
|
||||
|
Loading…
Reference in new issue