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.
This commit is contained in:
Dan Brown 2022-02-24 18:26:34 +00:00
parent 83082c32ef
commit dcb36b27a0
No known key found for this signature in database
GPG key ID: 46D9F943C24A2EF9
5 changed files with 36 additions and 7 deletions

View file

@ -1,6 +1,5 @@
name: New API Endpoint or API Ability name: New API Endpoint or API Ability
description: Request a new endpoint or API feature be added description: Request a new endpoint or API feature be added
title: "[API Request]: "
labels: [":nut_and_bolt: API Request"] labels: [":nut_and_bolt: API Request"]
body: body:
- type: textarea - type: textarea

View file

@ -1,6 +1,5 @@
name: Bug Report name: Bug Report
description: Create a report to help us improve or fix things description: Create a report to help us improve or fix things
title: "[Bug Report]: "
labels: [":bug: Bug"] labels: [":bug: Bug"]
body: body:
- type: textarea - type: textarea

View file

@ -1,6 +1,5 @@
name: Feature Request name: Feature Request
description: Request a new feature or idea to be added to BookStack description: Request a new feature or idea to be added to BookStack
title: "[Feature Request]: "
labels: [":hammer: Feature Request"] labels: [":hammer: Feature Request"]
body: body:
- type: textarea - type: textarea
@ -13,8 +12,42 @@ body:
- type: textarea - type: textarea
id: benefits id: benefits
attributes: attributes:
label: Describe the benefits this feature would bring to 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 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: validations:
required: true required: true
- type: textarea - type: textarea

View file

@ -1,6 +1,5 @@
name: Language Request name: Language Request
description: Request a new language to be added to CrowdIn for you to translate description: Request a new language to be added to CrowdIn for you to translate
title: "[Language Request]: "
labels: [":earth_africa: Translations"] labels: [":earth_africa: Translations"]
assignees: assignees:
- ssddanbrown - ssddanbrown

View file

@ -1,6 +1,5 @@
name: Support Request name: Support Request
description: Request support for a specific problem you have not been able to solve yourself description: Request support for a specific problem you have not been able to solve yourself
title: "[Support Request]: "
labels: [":dog2: Support"] labels: [":dog2: Support"]
body: body:
- type: checkboxes - type: checkboxes