From b2196d0a2e515d354318d489eca60d53154a24d9 Mon Sep 17 00:00:00 2001 From: Masayuki Igawa Date: Tue, 17 Sep 2019 15:01:18 +0900 Subject: [PATCH] Update issue templates This commit updates the issue template to adjust the current github's suggestion. This update enables a feature which provides options - bug report or feature request at the issue report page. feature_request.md template is copied from the github's default one since it's enough. And bug_report.md is combined the original issue_template.md with the github's default one. Fixes: #274 --- .github/ISSUE_TEMPLATE/bug_report.md | 30 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++++++++ .github/issue_template.md | 24 ------------------ 3 files changed, 50 insertions(+), 24 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/issue_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..b1a3d41b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,30 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: 'bug' +assignees: '' + +--- + +**Issue description** + +Include a description of the issue encountered, and what the expected behavior +was. Also include any configuration, test suite, or other relevant information +to reproduce the issue. + +Note if you encounter an error message try to re-run the command with --debug to print any tracebacks + +**Expected behavior and actual behavior** + +**Steps to reproduce the problem** + +**Specifications like the version of the project, operating system, or hardware** + +**System information** + - OS: [e.g. Windows10, openSUSE 15.1, Ubuntu 18.04] + - stestr version (`stestr --version`): + - Python release (`python --version`): + - pip packages (`pip freeze`): + +**Additional information** diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..36014cde --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: 'enhancement' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/issue_template.md b/.github/issue_template.md deleted file mode 100644 index 503cb3aa..00000000 --- a/.github/issue_template.md +++ /dev/null @@ -1,24 +0,0 @@ -### Issue description - -Include a description of the issue encountered, and what the expected behavior -was. Also include any configuration, test suite, or other relevant information -to reproduce the issue. - -Note if you encounter an error message try to re-run the command with --debug to print any tracebacks - -#### Expected behavior and actual behavior - -#### Steps to reproduce the problem - -#### Specifications like the version of the project, operating system, or hardware - -### System information - -**stestr version (`stestr --version`):** - -**Python release (`python --version`):** - -**pip packages (`pip freeze`):** - - -### Additional information