From d0adaa37a502c109023f4db116175ff9733fe93f Mon Sep 17 00:00:00 2001 From: Thomas Bouffard <27200110+tbouffard@users.noreply.github.com> Date: Tue, 30 Jun 2020 18:04:03 +0200 Subject: [PATCH] [INFRA] improve issue and pull request templates (#366) - issue: don't display link that allow the creation of blank issue (encourage contributors to use issue templates) - pull request: fix typo + improve 'link to issue' explanation --- .github/ISSUE_TEMPLATE/config.yml | 2 ++ .github/pull_request_template.md | 14 ++++++++------ 2 files changed, 10 insertions(+), 6 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..9e4a401a74 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,2 @@ +# see https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser +blank_issues_enabled: false diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index c34a891c70..1f9cc8169c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -5,10 +5,12 @@ Failure to do so may result in the rejection of the Pull Request. Put the title like `[KIND OF CHANGE] SHORT DESCRIPTION` -*KIND OF CHANGE* can be: -- Infra -- Bug -- Feat +*KIND OF CHANGE* can be (see existing Pull Request for more elements): +- DOC +- FEAT +- FIX +- INFRA +- REFACTOR ... **Details** @@ -16,6 +18,6 @@ Put the title like `[KIND OF CHANGE] SHORT DESCRIPTION` Explain the **details** for making this change: What existing problem does the Pull Request solve? Why is this feature beneficial? -**On automtatic closing of ISSUES** +**On automatic closing of ISSUES** -Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such). +Put `closes #XXXX` (remove backticks to let GitHub create the link) in your comment to auto-close the issue that your PR fixes (if such).