Skip to content

Commit

Permalink
Auto merge of rust-lang#9157 - Rqnsom:pull_request_template, r=flip1995
Browse files Browse the repository at this point in the history
update pull request template

Improved suggestion for formatting lint names in the PR template to use this format:
[`lint_name`]

changelog: none
  • Loading branch information
bors committed Jul 12, 2022
2 parents 9ebacd4 + 7f4e5d8 commit 07ab0e8
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,15 @@ Thank you for making Clippy better!
We're collecting our changelog from pull request descriptions.
If your PR only includes internal changes, you can just write
`changelog: none`. Otherwise, please write a short comment
explaining your change. Also, it's helpful for us that
the lint name is put into brackets `[]` and backticks `` ` ` ``,
e.g. ``[`lint_name`]``.
explaining your change.

If your PR fixes an issue, you can add "fixes #issue_number" into this
It's also helpful for us that the lint name is put within backticks (`` ` ` ``),
and then encapsulated by square brackets (`[]`), for example:
```
changelog: [`lint_name`]: your change
```

If your PR fixes an issue, you can add `fixes #issue_number` into this
PR description. This way the issue will be automatically closed when
your PR is merged.

Expand Down

0 comments on commit 07ab0e8

Please sign in to comment.