Skip to content

Commit 6958653

Browse files
beckettseanjtieri
andauthored
docs: update issue template forms (#21)
Signed-off-by: Sean Beckett <[email protected]> Co-authored-by: Justin Tieri <[email protected]>
1 parent c692534 commit 6958653

File tree

5 files changed

+47
-53
lines changed

5 files changed

+47
-53
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@ name: Bug Report
22
description: File a bug report.
33
title: "[Bug]: "
44
labels: ["bug", "triage"]
5-
projects: ["octo-org/1", "octo-org/44"]
6-
assignees:
7-
- octocat
85
body:
96
- type: markdown
107
attributes:
@@ -13,31 +10,33 @@ body:
1310
- type: textarea
1411
id: what-happened
1512
attributes:
16-
label: What happened?
17-
description: Also tell us, what did you expect to happen?
13+
label: What happened and what did you expect to happen?
1814
placeholder: Tell us what you see!
19-
value: "A bug happened!"
2015
validations:
2116
required: true
17+
- type: textarea
18+
id: reproduce
19+
attributes:
20+
label: Describe how to reproduce the bug
21+
placeholder: Step by step method to recreate the issue.
22+
validations:
23+
required: true
24+
- type: input
25+
id: Version
26+
attributes:
27+
label: version
28+
description: What version of the software are you using?
2229
- type: textarea
2330
id: logs
2431
attributes:
25-
label: Relevant log output
26-
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
32+
label: Relevant logs or stack trace
33+
description: Please copy and paste any relevant output from the code. This will be automatically formatted so no need for backticks.
2734
render: shell
2835
- type: checkboxes
2936
id: terms
3037
attributes:
3138
label: Code of Conduct
32-
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com).
39+
description: By submitting this issue, you agree to follow our [Code of Conduct](../../../CODE_OF_CONDUCT.md).
3340
options:
3441
- label: I agree to follow this project's Code of Conduct
3542
required: true
36-
- type: input
37-
id: contact
38-
attributes:
39-
label: Contact Details
40-
description: How can we get in touch with you if we need more info?
41-
placeholder: ex. [email protected]
42-
validations:
43-
required: false

.github/ISSUE_TEMPLATE/config.yml

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

.github/ISSUE_TEMPLATE/docs_issue.yml

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,16 @@
11
name: Docs Issue
2-
description: File a bug report.
3-
title: "[Docs Issue]: "
2+
description: Report an error or omission in the documentation.
3+
title: "[Docs]: "
44
labels: ["docs", "triage"]
55
body:
66
- type: markdown
77
attributes:
8-
value: Thanks for taking the time to let us know how we can approve the docs!
8+
value: Thanks for taking the time to let us know how we can improve the docs!
99
- type: input
1010
id: docs_page_link
1111
attributes:
1212
label: What page needs improvement?
13-
value: Link a URL if possible
14-
validations:
15-
required: true
13+
value: Link a URL
1614
- type: textarea
1715
id: description
1816
attributes:
@@ -27,15 +25,7 @@ body:
2725
id: terms
2826
attributes:
2927
label: Code of Conduct
30-
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com).
28+
description: By submitting this issue, you agree to follow our [Code of Conduct](../../../CODE_OF_CONDUCT.md).
3129
options:
3230
- label: I agree to follow this project's Code of Conduct
3331
required: true
34-
- type: input
35-
id: contact
36-
attributes:
37-
label: Contact Details
38-
description: How can we get in touch with you if we need more info?
39-
placeholder: ex. [email protected]
40-
validations:
41-
required: false

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,17 @@ body:
1010
placeholder: What's your end goal?
1111
validations:
1212
required: true
13-
- type: input
14-
id: version
13+
- type: textarea
14+
id: valueadd
1515
attributes:
16-
label: version
17-
description: What version of the software are you using?
16+
label: Use Cases and Audiences
17+
description: What new possibilities does this feature enable, and what types of users will find it helpful?
18+
placeholder: Who is the audience and what new applications would this feature enable?
1819
- type: checkboxes
1920
id: terms
2021
attributes:
2122
label: Code of Conduct
22-
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com).
23+
description: By submitting this issue, you agree to follow our [Code of Conduct](../../../CODE_OF_CONDUCT.md).
2324
options:
2425
- label: I agree to follow this project's Code of Conduct
2526
required: true
26-
- type: input
27-
id: contact
28-
attributes:
29-
label: Contact Details
30-
description: How can we get in touch with you if we need more info?
31-
placeholder: ex. [email protected]
32-
validations:
33-
required: false
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Unclassified Issue
2+
description: Open an issue
3+
title: "[Unclassified]: "
4+
labels: ["unclassified", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: Please open a Feature Request, Docs, or Bug Report issue, but if none of those are applicable you can use this generic form.
9+
- type: textarea
10+
id: description
11+
attributes:
12+
label: Issue Description
13+
- type: checkboxes
14+
id: terms
15+
attributes:
16+
label: Code of Conduct
17+
description: By submitting this issue, you agree to follow our [Code of Conduct](../../../CODE_OF_CONDUCT.md).
18+
options:
19+
- label: I agree to follow this project's Code of Conduct
20+
required: true

0 commit comments

Comments
 (0)