From dcb36b27a0d99288be96abde3d5c10d3a926dcd5 Mon Sep 17 00:00:00 2001 From: Dan Brown Date: Thu, 24 Feb 2022 18:26:34 +0000 Subject: [PATCH] Updated github issue templates - Removed titles since they don't provide added benefit upon the labels and would often lead to being submitted with just the placeholder title. - Feature request form - Added further context to benefits field for hopefully better responses that target the core goal. - Added a field to ask if feature can already be achieved, to gain an idea if the submitter has explored other options (if existing). - Added a field to ensure the submitter has search the issue list before submitting. - Added a field to ask existing BookStack usage time to understand potential evolution of usage and/or influence of other platforms. --- .github/ISSUE_TEMPLATE/api_request.yml | 1 - .github/ISSUE_TEMPLATE/bug_report.yml | 1 - .github/ISSUE_TEMPLATE/feature_request.yml | 39 +++++++++++++++++++-- .github/ISSUE_TEMPLATE/language_request.yml | 1 - .github/ISSUE_TEMPLATE/support_request.yml | 1 - 5 files changed, 36 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/api_request.yml b/.github/ISSUE_TEMPLATE/api_request.yml index 81e11e23d..def952c52 100644 --- a/.github/ISSUE_TEMPLATE/api_request.yml +++ b/.github/ISSUE_TEMPLATE/api_request.yml @@ -1,6 +1,5 @@ name: New API Endpoint or API Ability description: Request a new endpoint or API feature be added -title: "[API Request]: " labels: [":nut_and_bolt: API Request"] body: - type: textarea diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 35aa481db..aa9a099c0 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,6 +1,5 @@ name: Bug Report description: Create a report to help us improve or fix things -title: "[Bug Report]: " labels: [":bug: Bug"] body: - type: textarea diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 078078e90..4826cc5ea 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,6 +1,5 @@ name: Feature Request description: Request a new feature or idea to be added to BookStack -title: "[Feature Request]: " labels: [":hammer: Feature Request"] body: - type: textarea @@ -13,8 +12,42 @@ body: - type: textarea id: benefits attributes: - label: Describe the benefits this feature would bring to BookStack users - description: Explain the measurable benefits this feature would achieve for existing BookStack users + label: Describe the benefits this would bring to existing BookStack users + description: | + Explain the measurable benefits this feature would achieve for existing BookStack users. + These benefits should details outcomes in terms of what this request solves/achieves, and should not be specific to implementation. + This helps us understand the core desired goal so that a variety of potential implementations could be explored. + This field is important. Lack if input here may lead to early issue closure. + validations: + required: true + - type: textarea + id: already_achieved + attributes: + label: Can the goal of this request already be achieved via other means? + description: | + Yes/No. If yes, please describe how the requested approach fits in with the existing method. + validations: + required: true + - type: checkboxes + id: confirm-search + attributes: + label: Have you searched for an existing open/closed issue? + description: | + To help us keep these issues under control, please ensure you have first [searched our issue list](https://github.com/BookStackApp/BookStack/issues?q=is%3Aissue) + for any existing issues that cover the fundemental benefit/goal of your request. + options: + - label: I have searched for existing issues and none cover my fundemental request + required: true + - type: dropdown + id: existing_usage + attributes: + label: How long have you been using BookStack? + options: + - Not using yet, just scoping + - 0 to 6 months + - 6 months to 1 year + - 1 to 5 years + - Over 5 years validations: required: true - type: textarea diff --git a/.github/ISSUE_TEMPLATE/language_request.yml b/.github/ISSUE_TEMPLATE/language_request.yml index b94bb88bc..6f768cd74 100644 --- a/.github/ISSUE_TEMPLATE/language_request.yml +++ b/.github/ISSUE_TEMPLATE/language_request.yml @@ -1,6 +1,5 @@ name: Language Request description: Request a new language to be added to CrowdIn for you to translate -title: "[Language Request]: " labels: [":earth_africa: Translations"] assignees: - ssddanbrown diff --git a/.github/ISSUE_TEMPLATE/support_request.yml b/.github/ISSUE_TEMPLATE/support_request.yml index bd52b12af..cb2476546 100644 --- a/.github/ISSUE_TEMPLATE/support_request.yml +++ b/.github/ISSUE_TEMPLATE/support_request.yml @@ -1,6 +1,5 @@ name: Support Request description: Request support for a specific problem you have not been able to solve yourself -title: "[Support Request]: " labels: [":dog2: Support"] body: - type: checkboxes