Skip to content

Commit dcb36b2

Browse files
committed
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.
1 parent 83082c3 commit dcb36b2

File tree

5 files changed

+36
-7
lines changed

5 files changed

+36
-7
lines changed

.github/ISSUE_TEMPLATE/api_request.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
name: New API Endpoint or API Ability
22
description: Request a new endpoint or API feature be added
3-
title: "[API Request]: "
43
labels: [":nut_and_bolt: API Request"]
54
body:
65
- type: textarea

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
name: Bug Report
22
description: Create a report to help us improve or fix things
3-
title: "[Bug Report]: "
43
labels: [":bug: Bug"]
54
body:
65
- type: textarea

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
name: Feature Request
22
description: Request a new feature or idea to be added to BookStack
3-
title: "[Feature Request]: "
43
labels: [":hammer: Feature Request"]
54
body:
65
- type: textarea
@@ -13,8 +12,42 @@ body:
1312
- type: textarea
1413
id: benefits
1514
attributes:
16-
label: Describe the benefits this feature would bring to BookStack users
17-
description: Explain the measurable benefits this feature would achieve for existing BookStack users
15+
label: Describe the benefits this would bring to existing BookStack users
16+
description: |
17+
Explain the measurable benefits this feature would achieve for existing BookStack users.
18+
These benefits should details outcomes in terms of what this request solves/achieves, and should not be specific to implementation.
19+
This helps us understand the core desired goal so that a variety of potential implementations could be explored.
20+
This field is important. Lack if input here may lead to early issue closure.
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: already_achieved
25+
attributes:
26+
label: Can the goal of this request already be achieved via other means?
27+
description: |
28+
Yes/No. If yes, please describe how the requested approach fits in with the existing method.
29+
validations:
30+
required: true
31+
- type: checkboxes
32+
id: confirm-search
33+
attributes:
34+
label: Have you searched for an existing open/closed issue?
35+
description: |
36+
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)
37+
for any existing issues that cover the fundemental benefit/goal of your request.
38+
options:
39+
- label: I have searched for existing issues and none cover my fundemental request
40+
required: true
41+
- type: dropdown
42+
id: existing_usage
43+
attributes:
44+
label: How long have you been using BookStack?
45+
options:
46+
- Not using yet, just scoping
47+
- 0 to 6 months
48+
- 6 months to 1 year
49+
- 1 to 5 years
50+
- Over 5 years
1851
validations:
1952
required: true
2053
- type: textarea

.github/ISSUE_TEMPLATE/language_request.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
name: Language Request
22
description: Request a new language to be added to CrowdIn for you to translate
3-
title: "[Language Request]: "
43
labels: [":earth_africa: Translations"]
54
assignees:
65
- ssddanbrown

.github/ISSUE_TEMPLATE/support_request.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
name: Support Request
22
description: Request support for a specific problem you have not been able to solve yourself
3-
title: "[Support Request]: "
43
labels: [":dog2: Support"]
54
body:
65
- type: checkboxes

0 commit comments

Comments
 (0)