Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

♲ Fix the rendering of PR templates #2169

Merged
merged 1 commit into from Aug 21, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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)