Skip to content

Commit f252df8

Browse files
Update the PR template to be consistent with contributing guidelines
PR #650 Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
1 parent 0e3dc6a commit f252df8

2 files changed

Lines changed: 10 additions & 5 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,14 @@
2121
* The format is &lt;Name&gt; &lt;Surname&gt;.
2222
* Please keep the list in alphabetical order, the file is sorted by name.
2323
- [ ] Add a new news fragment into the `CHANGES` folder
24-
* name it `<issue_id>.<type>` for example (588.bugfix)
24+
* name it `<issue_id>.<category>` for example (588.bugfix)
2525
* if you don't have an `issue_id` change it to the pr id after creating the pr
26-
* ensure type is one of the following:
27-
* `.feature`: Signifying a new feature.
26+
* ensure category is one of the following:
2827
* `.bugfix`: Signifying a bug fix.
28+
* `.feature`: Signifying a new feature.
29+
* `.breaking`: Signifying a breaking change or removal of something public.
2930
* `.doc`: Signifying a documentation improvement.
30-
* `.removal`: Signifying a deprecation or removal of public API.
31-
* `.misc`: A ticket has been closed, but it is not of interest to users.
31+
* `.packaging`: Signifying a packaging or tooling change that may be relevant to downstreams.
32+
* `.contrib`: Signifying an improvement to the contributor/development experience.
33+
* `.misc`: Anything that does not fit the above; usually, something not of interest to users.
3234
* Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."

CHANGES/650.contrib

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
The pull request template to be consistent with :ref:`the contributing guidelines
2+
<adding change notes with your prs>`, particularly the list of categories
3+
-- by :user:`musicinmybrain`.

0 commit comments

Comments
 (0)