Mirrors/rust-clippy
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-clippy synced 2024-11-27 07:00:55 +00:00
Code Issues Projects Releases Packages Wiki Activity

update pull request template

Browse source 
Improved suggestion for formatting lint names in the template:

    changelog: [`lint_name`]: your change
This commit is contained in:
Korlo 2022-07-12 11:17:30 +02:00
parent 7c1598b399
commit 7f4e5d8cc4
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
.github/PULL_REQUEST_TEMPLATE.md vendored
View file

@ -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.