X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=.github%2FPULL_REQUEST_TEMPLATE.md;h=9e49f60892d26490c047173c568d15e9690f82e3;hb=a7162f29b419f7478f2a365dfe46f5bee2aec227;hp=6c92e10522c99feb0e7f07bf7d6e66a9e0ecde96;hpb=df855321126580ace6e3022372991c725d3e1b0a;p=rust.git diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 6c92e10522c..9e49f60892d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,11 +1,17 @@ Thank you for making Clippy better! We're collecting our changelog from pull request descriptions. -If your PR only updates to the latest nightly, you can leave the -`changelog` entry as `none`. Otherwise, please write a short comment +If your PR only includes internal changes, you can just write +`changelog: none`. Otherwise, please write a short comment 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. @@ -28,5 +34,6 @@ Delete this line and everything above before opening your PR. --- -*Please keep the line below* -changelog: none +*Please write a short comment explaining your change (or "none" for internal only changes)* + +changelog: