Skip to content

Commit aac6a69

Browse files
svenvg93alexjustesen
svenvg93
and
alexjustesen
authored
[QoL] Add issue and request templates (#2140)
Co-authored-by: Alex Justesen <[email protected]>
1 parent 111067d commit aac6a69

File tree

8 files changed

+201
-53
lines changed

8 files changed

+201
-53
lines changed

‎.github/DISCUSSION_TEMPLATE/general.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
body:
2+
- type: checkboxes
3+
attributes:
4+
label: Checklist
5+
description: Following the guidelines can make you more likely to get responses.
6+
options:
7+
- label: >-
8+
I have read and accepted the
9+
[contributing guidelines](https://github.com/alexjustesen/speedtest-tracker/blob/main/CONTRIBUTING.md).
10+
required: true
11+
- type: textarea
12+
attributes:
13+
label: Description
14+
description: Please describe in detail what you want to share.
15+
validations:
16+
required: true

‎.github/DISCUSSION_TEMPLATE/ideas.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
body:
2+
- type: dropdown
3+
id: idea-section
4+
attributes:
5+
label: "Which part of the application does your idea belong to?"
6+
description: "Select the section of the application that your idea pertains to."
7+
options:
8+
- "Charts"
9+
- "Notifications"
10+
- "Speedtest"
11+
- "WebGui"
12+
default: 0
13+
validations:
14+
required: true
15+
- type: textarea
16+
attributes:
17+
label: Description
18+
description: Please describe in detail what you want to share.
19+
validations:
20+
required: true
21+

‎.github/DISCUSSION_TEMPLATE/q-a.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
body:
2+
- type: checkboxes
3+
attributes:
4+
label: Checklist
5+
description: |
6+
Before opening an Q&A make sure you've checked the resources below first, any Q&A that could have been solved by reading the docs or existing issues will be closed.
7+
options:
8+
- label: I have read the [docs](https://docs.speedtest-tracker.dev/help/faqs).
9+
required: true
10+
- label: I have searched open and closed issues.
11+
required: true
12+
- type: dropdown
13+
id: deployment-environment
14+
attributes:
15+
label: Deployment Environment
16+
description: How did you deploy the application?
17+
options:
18+
- Docker Compose
19+
- Docker Run
20+
- Bare Metal
21+
default: 0
22+
validations:
23+
required: true
24+
- type: textarea
25+
attributes:
26+
label: Description
27+
description: Please describe your qeustion in detail.
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
attributes:
33+
label: Anything else?
34+
description: |
35+
Links? References? Or logs? Anything that will give us more context about the issue you are encountering!

‎.github/ISSUE_TEMPLATE/BUG_REPORT_FORM.yml‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: Bug Report
2+
description: Use this template to report a bug or issue.
3+
title: "[Bug]: "
4+
labels: ["bug", "unverified"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report! You should only use this form for issues, to request a change or feature use the [feature request form](https://github.com/alexjustesen/speedtest-tracker).
10+
- type: checkboxes
11+
attributes:
12+
label: Pre-work
13+
description: |
14+
Before opening an issue make sure you've checked the resources below first, any issues that could have been solved by reading the docs or existing issues will be closed.
15+
options:
16+
- label: I have read the [docs](https://docs.speedtest-tracker.dev).
17+
required: true
18+
- label: I have searched open and closed issues.
19+
required: true
20+
- label: I agree to follow this project's [Code of Conduct]().
21+
required: true
22+
- type: textarea
23+
id: description
24+
attributes:
25+
label: Description
26+
description: Explain the issue you experienced, please be clear and concise.
27+
placeholder: I went to the coffee pot and it was empty.
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: expected-behavior
32+
attributes:
33+
label: Expected Behavior
34+
description: In a perfect world, what should have happened?
35+
placeholder: When I got to the coffee pot, it should have been full.
36+
validations:
37+
required: true
38+
- type: textarea
39+
id: steps-to-reproduce
40+
attributes:
41+
label: Steps to Reproduce
42+
description: Describe how to reproduce the issue in repeatable steps.
43+
placeholder: |
44+
1. Go to the coffee pot.
45+
2. Make more coffee.
46+
3. Pour it into a cup.
47+
validations:
48+
required: true
49+
- type: dropdown
50+
id: deployment-environment
51+
attributes:
52+
label: Deployment Environment
53+
description: How did you deploy the application?
54+
options:
55+
- Docker Compose
56+
- Docker Run
57+
- Bare Metal
58+
default: 0
59+
validations:
60+
required: true
61+
- type: textarea
62+
id: application-information
63+
attributes:
64+
label: Application Information
65+
description: To generate application information run `php artisan about --json` from the application's path. This will be automatically formatted into code, so no need for backticks.
66+
render: json
67+
validations:
68+
required: true
69+
- type: input
70+
id: browsers
71+
attributes:
72+
label: What browser(s) are you seeing the problem on?
73+
placeholder: Chrome, Firefox, Safari, etc.
74+
validations:
75+
required: true
76+
- type: textarea
77+
id: logs
78+
attributes:
79+
label: Logs
80+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
81+
render: shell

‎.github/ISSUE_TEMPLATE/FEATURE_REQUEST_FORM.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Feature Request
2+
description: Use this template for requesting a new feature or change.
3+
title: "[Feature]: "
4+
labels: ["feature", "needs-review"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
You should only use this form to request a change or new feature, to report a bug or issue use the [bug report form](https://github.com/alexjustesen/speedtest-tracker).
10+
- type: checkboxes
11+
attributes:
12+
label: Pre-work
13+
options:
14+
- label: I have searched open and closed feature request to make sure this or similar feature request does not already exist.
15+
required: true
16+
- label: I have reviewed the [milestones](https://github.com/alexjustesen/speedtest-tracker/milestones) to ensure that this feature request, or a similar one, has not already been proposed.
17+
required: true
18+
- label: I agree to follow this project's [Code of Conduct]().
19+
required: true
20+
- type: dropdown
21+
id: idea-section
22+
attributes:
23+
label: Which part of the application does your feature belong to?
24+
description: Select the section of the application that your feature pertains to.
25+
options:
26+
- Charts
27+
- Notifications
28+
- Speedtest
29+
- WebGui
30+
default: 0
31+
validations:
32+
required: true
33+
- type: textarea
34+
id: description
35+
attributes:
36+
label: Description
37+
description: Describe the solution or feature you'd like, you should also mention if this solves a problem.
38+
placeholder: Be sure to keep it clear and concise.
39+
validations:
40+
required: true

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 0 additions & 36 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: GitHub Community Support
4+
url: https://github.com/orgs/community/discussions
5+
about: Please ask and answer questions here.
6+
- name: GitHub Security Bug Bounty
7+
url: https://bounty.github.com/
8+
about: Please report security vulnerabilities here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 0 additions & 17 deletions
This file was deleted.

0 commit comments

Comments
 (0)