diff options
| author | bors <bors@rust-lang.org> | 2022-07-12 16:07:38 +0000 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2022-07-12 16:07:38 +0000 |
| commit | 07ab0e87417e8cea018a34c7cd46fde0693d32a5 (patch) | |
| tree | 7f2e98f75e53d09d9604c6b65730c41c6d23ea01 | |
| parent | 9ebacd48742e2cdefa406de2a84753f4a078912d (diff) | |
| parent | 7f4e5d8cc4afb4b911d11a0cdb0ab8bcb0404653 (diff) | |
| download | rust-07ab0e87417e8cea018a34c7cd46fde0693d32a5.tar.gz rust-07ab0e87417e8cea018a34c7cd46fde0693d32a5.zip | |
Auto merge of #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
| -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. |