From 964d674884ab2f9ae8da1f03de77db3eefd03fc0 Mon Sep 17 00:00:00 2001 From: Matthias Mair Date: Mon, 8 Aug 2022 03:12:52 +0200 Subject: [PATCH] Update issue templates to GH forms (#3495) * move bug report to form * add more options * move FRs to templates * add tag information --- .github/ISSUE_TEMPLATE/bug_report.md | 47 ---------------- .github/ISSUE_TEMPLATE/bug_report.yaml | 62 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 26 --------- .github/ISSUE_TEMPLATE/feature_request.yaml | 53 ++++++++++++++++++ CONTRIBUTING.md | 3 + 5 files changed, 118 insertions(+), 73 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 55585c76700b..000000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -name: Bug -about: Create a bug report to help us improve InvenTree! -title: "[BUG] Enter bug description" -labels: bug, question -assignees: '' - ---- - - - - -**Describe the bug** - - -**Steps to Reproduce** - -Steps to reproduce the behavior: - - -**Expected behavior** - - - - -**Deployment Method** -- [ ] Docker -- [ ] Bare Metal - -**Version Information** - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 000000000000..2c1bad05930a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,62 @@ +name: "Bug" +description: "Create a bug report to help us improve InvenTree!" +labels: ["bug", "question", "triage:not-checked"] +body: + - type: checkboxes + id: no-duplicate-issues + attributes: + label: "Please verify that this bug has NOT been raised before." + description: "Search in the issues sections by clicking [HERE](https://github.com/inventree/inventree/issues?q=)" + options: + - label: "I checked and didn't find similar issue" + required: true + - type: textarea + id: description + validations: + required: true + attributes: + label: "Describe the bug*" + description: "A clear and concise description of what the bug is." + - type: textarea + id: steps-to-reproduce + validations: + required: true + attributes: + label: "Steps to Reproduce" + description: "Steps to reproduce the behavior, please make it detailed" + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + - type: textarea + id: expected-behavior + validations: + required: true + attributes: + label: "Expected behavior" + description: "A clear and concise description of what you expected to happen." + placeholder: "..." + - type: checkboxes + id: deployment + attributes: + label: "Deployment Method" + options: + - label: "Docker" + - label: "Bare metal" + - type: textarea + id: version-info + validations: + required: true + attributes: + label: "Version Information" + description: "The version info block." + placeholder: "You can get this by going to the `About InvenTree` section in the upper right corner and clicking on to the `copy version information`" + - type: textarea + id: logs + attributes: + label: "Relevant log output" + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index ca9ff88a5865..000000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "[FR]" -labels: enhancement -assignees: '' - ---- - -**Is your feature request the result of a bug?** -Please link it here. - -**Problem** -A clear and concise description of what the problem is. e.g. I'm always frustrated when [...] - -**Suggested solution** -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. - -**Examples of other systems** -Show how other software handles your FR if you have examples. - -**Do you want to develop this?** -If so please describe briefly how you would like to implement it (so we can give advice) and if you have experience in the needed technology (you do not need to be a pro - this is just as a information for us). diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 000000000000..72fd4938a68d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,53 @@ +name: Feature Request +description: Suggest an idea for this project +title: "[FR] title" +labels: ["enhancement", "triage:not-checked"] +body: + - type: checkboxes + id: no-duplicate-issues + attributes: + label: "Please verify that this feature request has NOT been suggested before." + description: "Search in the issues sections by clicking [HERE](https://github.com/inventree/inventree/issues?q=)" + options: + - label: "I checked and didn't find similar feature request" + required: true + - type: textarea + id: problem + validations: + required: true + attributes: + label: "Problem statement" + description: "A clear and concise description of what the solved problem or feature request is." + placeholder: "I am always struggeling with ..." + - type: textarea + id: solution + validations: + required: true + attributes: + label: "Suggested solution" + description: "A clear and concise description of what you want to happen." + placeholder: "In my use-case, ..." + - type: textarea + id: alternatives + validations: + required: true + attributes: + label: "Describe alternatives you've considered" + description: "A clear and concise description of any alternative solutions or features you've considered." + placeholder: "This could also be done by doing ..." + - type: textarea + id: examples + validations: + required: false + attributes: + label: "Examples of other systems" + description: "Show how other software handles your FR if you have examples." + placeholder: "I software xxx this is done in the following way..." + - type: checkboxes + id: self-develop + attributes: + label: "Do you want to develop this?" + description: "you do not need to be a pro - this is just as a information for us" + options: + - label: "I want to develop this." + required: false diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e9b01c65173b..bbcdfd703ddb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -167,6 +167,9 @@ HTML and javascript files are passed through the django templating engine. Trans The tags describe issues and PRs in multiple areas: | Area | Name | Description | |---|---|---| +| Triage Labels | | | +| | triage:not-checked | Item was not checked by the core team | +| | triage:not-approved | Item is not green-light by maintainer | | Type Labels | | | | | breaking | Indicates a major update or change which breaks compatibility | | | bug | Identifies a bug which needs to be addressed |