Skip to content

Commit

Permalink
[INFRA] improve issue and pull request templates (#366)
Browse files Browse the repository at this point in the history
- 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
  • Loading branch information
tbouffard authored Jun 30, 2020
1 parent fd3e23d commit d0adaa3
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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
14 changes: 8 additions & 6 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,19 @@ 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**

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).

0 comments on commit d0adaa3

Please sign in to comment.