Skip to content

Commit 07ab0e8

Browse files
committed
Auto merge of rust-lang#9157 - Rqnsom:pull_request_template, r=flip1995
update pull request template Improved suggestion for formatting lint names in the PR template to use this format: [`lint_name`] changelog: none
2 parents 9ebacd4 + 7f4e5d8 commit 07ab0e8

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,15 @@ Thank you for making Clippy better!
33
We're collecting our changelog from pull request descriptions.
44
If your PR only includes internal changes, you can just write
55
`changelog: none`. Otherwise, please write a short comment
6-
explaining your change. Also, it's helpful for us that
7-
the lint name is put into brackets `[]` and backticks `` ` ` ``,
8-
e.g. ``[`lint_name`]``.
6+
explaining your change.
97

10-
If your PR fixes an issue, you can add "fixes #issue_number" into this
8+
It's also helpful for us that the lint name is put within backticks (`` ` ` ``),
9+
and then encapsulated by square brackets (`[]`), for example:
10+
```
11+
changelog: [`lint_name`]: your change
12+
```
13+
14+
If your PR fixes an issue, you can add `fixes #issue_number` into this
1115
PR description. This way the issue will be automatically closed when
1216
your PR is merged.
1317

0 commit comments

Comments
 (0)