From 558e3be0c8deed2554f2de1968112dc408b37406 Mon Sep 17 00:00:00 2001 From: kjeld Schouten-Lebbing Date: Thu, 28 May 2020 15:01:21 +0200 Subject: [PATCH] Redo all the templates and remove the old once --- .github/ISSUE_TEMPLATE/bug_report.md | 27 ++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++ .github/PULL_REQUEST_TEMPLATE/bug_fix.md | 40 ++++++++++++++++++ .../general_improvement.md | 40 ++++++++++++++++++ .../PULL_REQUEST_TEMPLATE/new_blueprint.md | 41 +++++++++++++++++++ docs/ISSUE_TEMPLATE.md | 13 ------ docs/PULL_REQUEST_TEMPLATE.md | 16 -------- 7 files changed, 168 insertions(+), 29 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/bug_fix.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/general_improvement.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/new_blueprint.md delete mode 100644 docs/ISSUE_TEMPLATE.md delete mode 100644 docs/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..71a89b41 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,27 @@ +--- +name: Bug report +about: Create a report to help us improve JailMan +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..e74cb57f --- /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: Feature +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/PULL_REQUEST_TEMPLATE/bug_fix.md b/.github/PULL_REQUEST_TEMPLATE/bug_fix.md new file mode 100644 index 00000000..d9c6fc45 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/bug_fix.md @@ -0,0 +1,40 @@ +--- +name: Bug Fix +about: Submit a fix to help us improve JailMan +title: '' +labels: bug +assignees: '' + +--- + +**Description** + +Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. + +Fixes # (issue) + +**Type of change** + +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Refactor of current code +- [ ] This change requires additional documentation update + +**How Has This Been Tested?** + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration + +- [ ] Test A +- [ ] Test B + +**Notes:** +_Please enter any other relevant information here_ + +**Checklist:** + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests to this description that prove my fix is effective or that my feature works +- [ ] Any new files are named using lowercase (to avoid issues on case sensitive file systems) \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/general_improvement.md b/.github/PULL_REQUEST_TEMPLATE/general_improvement.md new file mode 100644 index 00000000..e2af3b8e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/general_improvement.md @@ -0,0 +1,40 @@ +--- +name: General Improvement +about: Submit a fix to help us improve JailMan +title: '' +labels: enhancement +assignees: '' + +--- + +**Description** + +Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. + +Fixes # (issue) + +**Type of change** + +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Refactor of current code +- [ ] This change requires additional documentation update + +**How Has This Been Tested?** + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration + +- [ ] Test A +- [ ] Test B + +**Notes:** +_Please enter any other relevant information here_ + +**Checklist:** + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests to this description that prove my fix is effective or that my feature works +- [ ] Any new files are named using lowercase (to avoid issues on case sensitive file systems) \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/new_blueprint.md b/.github/PULL_REQUEST_TEMPLATE/new_blueprint.md new file mode 100644 index 00000000..1c264ab0 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/new_blueprint.md @@ -0,0 +1,41 @@ +--- +name: New Blueprint +about: Submit a new blueprint to help us expand JailMan +title: '' +labels: feature +assignees: '' + +--- + +**Description** + +Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. + +Fixes # (issue) + +**Type of change** + +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Refactor of current code +- [ ] This change requires additional documentation update + +**How Has This Been Tested?** + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration + +- [ ] Test A +- [ ] Test B + +**Notes:** +_Please enter any other relevant information here_ + +**Checklist:** + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests to this description that prove my fix is effective or that my feature works +- [ ] Any new files are named using lowercase (to avoid issues on case sensitive file systems) +- [ ] I've added myself as a codeowner for the new blueprint in /docs/CODEOWNERS \ No newline at end of file diff --git a/docs/ISSUE_TEMPLATE.md b/docs/ISSUE_TEMPLATE.md deleted file mode 100644 index 89fb703e..00000000 --- a/docs/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,13 +0,0 @@ -# Issue Template - -## Description - -### Detailed Bug Report -It helps if you include any relevant code / config (for describing how new features should work), images, gifs, or youtube videos! - -### Steps to Reproduce -Please enter the steps to reproduce the bug or behaviour: - -1. -2. -3. \ No newline at end of file diff --git a/docs/PULL_REQUEST_TEMPLATE.md b/docs/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index ed2f76f0..00000000 --- a/docs/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,16 +0,0 @@ -# Pull Request Template - -### Purpose -_Describe the problem the PR fixes or the feature it introduces_
-_Don't forget to use "Fixes #issuenumber" to select issues and auto close them on merge_ - -### Notes: -_Please enter any other relevant information here_ - -### Please make sure you have followed the self checks below before submitting a PR: - -- [ ] Code is sufficiently commented -- [ ] Code is indented with tabs and not spaces -- [ ] The PR does not bring up any new errors -- [ ] The PR has been tested -- [ ] Any new files are named using lowercase (to avoid issues on case sensitive file systems)