Skip to content
This repository has been archived by the owner on Feb 21, 2023. It is now read-only.

Commit

Permalink
Merge pull request #600 from Mariatta/patch-1
Browse files Browse the repository at this point in the history
Add project specific PR template, including CONTRIBUTORS.txt
  • Loading branch information
webknjaz committed May 30, 2019
2 parents e8c33e3 + 0f10f72 commit 7765dff
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,33 @@
<!-- Thank you for your contribution! -->

## What do these changes do?

<!-- Please give a short brief about these changes. -->

## Are there changes in behavior for the user?

<!-- Outline any notable behaviour for the end users. -->

## Related issue number

<!-- Are there any issues opened that will be resolved by merging this change? -->

## Checklist

- [ ] I think the code is well written
- [ ] Unit tests for the changes exist
- [ ] Documentation reflects the changes
- [ ] If you provide code modification, please add yourself to `CONTRIBUTORS.txt`
* The format is `<Name> <Surname>`.
* Please keep alphabetical order, the file is sorted by names.
- [ ] Add a new news fragment into the [`CHANGES/`](../tree/master/CHANGES) folder
* name it `<issue_id>.<type>` (e.g. `588.bugfix`)
* if you don't have an `issue_id` change it to the pr id after creating the PR
* ensure type is one of the following:
* `.feature`: Signifying a new feature.
* `.bugfix`: Signifying a bug fix.
* `.doc`: Signifying a documentation improvement.
* `.removal`: Signifying a deprecation or removal of public API.
* `.misc`: A ticket has been closed, but it is not of interest to users.
* Make sure to use full sentences with correct case and punctuation, for example:
`Fix issue with non-ascii contents in doctest text files.`

0 comments on commit 7765dff

Please sign in to comment.