diff options
| author | Korlo <88337245+Rqnsom@users.noreply.github.com> | 2022-07-12 11:17:30 +0200 |
|---|---|---|
| committer | Korlo <88337245+Rqnsom@users.noreply.github.com> | 2022-07-12 17:26:30 +0200 |
| commit | 7f4e5d8cc4afb4b911d11a0cdb0ab8bcb0404653 (patch) | |
| tree | aa1c7139f8315535f7ce0f991bc670a0eabae169 | |
| parent | 7c1598b399c39403e6badd98c8d163b07dc89079 (diff) | |
| download | rust-7f4e5d8cc4afb4b911d11a0cdb0ab8bcb0404653.tar.gz rust-7f4e5d8cc4afb4b911d11a0cdb0ab8bcb0404653.zip | |
update pull request template
Improved suggestion for formatting lint names in the template:
changelog: [`lint_name`]: your change
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 780ee9d63df..9e49f60892d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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. |