X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=.github%2FPULL_REQUEST_TEMPLATE.md;h=9e49f60892d26490c047173c568d15e9690f82e3;hb=a7162f29b419f7478f2a365dfe46f5bee2aec227;hp=a3f114e0bb34f4e64c8eb233afa49b344d106f33;hpb=db0464103e46b7f1bd44f0866ae88b0688da19b8;p=rust.git diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index a3f114e0bb3..9e49f60892d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -5,7 +5,13 @@ 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. @@ -29,4 +35,5 @@ Delete this line and everything above before opening your PR. --- *Please write a short comment explaining your change (or "none" for internal only changes)* + changelog: