Skip to content

Commit

Permalink
♲ Fix the rendering of PR templates (#2169)
Browse files Browse the repository at this point in the history
  • Loading branch information
webknjaz committed Aug 21, 2021
1 parent 3dbc21f commit e1f1826
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Expand Up @@ -14,9 +14,12 @@ much about the checklist - we will help you get started.
in message body
- [ ] added news fragment in [changelog folder](../tree/master/docs/changelog)
* fragment name: `<issue number>.<type>.rst` for example (588.bugfix.rst)
* `<type>` is must be one of `bugfix`, `feature`, `deprecation`,`breaking`, `doc`, `misc`
* `<type>` is must be one of `bugfix`, `feature`, `deprecation`, `breaking`, `doc`, `misc`
* if PR has no issue: consider creating one first or change it to the PR number after creating the PR
* "sign" fragment with "by :user:`<your username>`"
* please use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files - by :user:`superuser`."
* "sign" fragment with ```-- by :user:`<your username>`.```
* please, use full sentences with correct case and punctuation, for example:
```rst
Fixed an issue with non-ascii contents in doctest text files -- by :user:`superuser`.
```
* also see [examples](../tree/master/docs/changelog)
- [ ] added yourself to `CONTRIBUTORS` (preserving alphabetical order)

0 comments on commit e1f1826

Please sign in to comment.