-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update issue template forms (#21)
Signed-off-by: Sean Beckett <[email protected]> Co-authored-by: Justin Tieri <[email protected]>
- Loading branch information
1 parent
c692534
commit 6958653
Showing
5 changed files
with
47 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,9 +2,6 @@ name: Bug Report | |
description: File a bug report. | ||
title: "[Bug]: " | ||
labels: ["bug", "triage"] | ||
projects: ["octo-org/1", "octo-org/44"] | ||
assignees: | ||
- octocat | ||
body: | ||
- type: markdown | ||
attributes: | ||
|
@@ -13,31 +10,33 @@ body: | |
- type: textarea | ||
id: what-happened | ||
attributes: | ||
label: What happened? | ||
description: Also tell us, what did you expect to happen? | ||
label: What happened and what did you expect to happen? | ||
placeholder: Tell us what you see! | ||
value: "A bug happened!" | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: reproduce | ||
attributes: | ||
label: Describe how to reproduce the bug | ||
placeholder: Step by step method to recreate the issue. | ||
validations: | ||
required: true | ||
- type: input | ||
id: Version | ||
attributes: | ||
label: version | ||
description: What version of the software are you using? | ||
- type: textarea | ||
id: logs | ||
attributes: | ||
label: Relevant log output | ||
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. | ||
label: Relevant logs or stack trace | ||
description: Please copy and paste any relevant output from the code. This will be automatically formatted so no need for backticks. | ||
render: shell | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com). | ||
description: By submitting this issue, you agree to follow our [Code of Conduct](../../../CODE_OF_CONDUCT.md). | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true | ||
- type: input | ||
id: contact | ||
attributes: | ||
label: Contact Details | ||
description: How can we get in touch with you if we need more info? | ||
placeholder: ex. [email protected] | ||
validations: | ||
required: false |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,16 @@ | ||
name: Docs Issue | ||
description: File a bug report. | ||
title: "[Docs Issue]: " | ||
description: Report an error or omission in the documentation. | ||
title: "[Docs]: " | ||
labels: ["docs", "triage"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: Thanks for taking the time to let us know how we can approve the docs! | ||
value: Thanks for taking the time to let us know how we can improve the docs! | ||
- type: input | ||
id: docs_page_link | ||
attributes: | ||
label: What page needs improvement? | ||
value: Link a URL if possible | ||
validations: | ||
required: true | ||
value: Link a URL | ||
- type: textarea | ||
id: description | ||
attributes: | ||
|
@@ -27,15 +25,7 @@ body: | |
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com). | ||
description: By submitting this issue, you agree to follow our [Code of Conduct](../../../CODE_OF_CONDUCT.md). | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true | ||
- type: input | ||
id: contact | ||
attributes: | ||
label: Contact Details | ||
description: How can we get in touch with you if we need more info? | ||
placeholder: ex. [email protected] | ||
validations: | ||
required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,24 +10,17 @@ body: | |
placeholder: What's your end goal? | ||
validations: | ||
required: true | ||
- type: input | ||
id: version | ||
- type: textarea | ||
id: valueadd | ||
attributes: | ||
label: version | ||
description: What version of the software are you using? | ||
label: Use Cases and Audiences | ||
description: What new possibilities does this feature enable, and what types of users will find it helpful? | ||
placeholder: Who is the audience and what new applications would this feature enable? | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com). | ||
description: By submitting this issue, you agree to follow our [Code of Conduct](../../../CODE_OF_CONDUCT.md). | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true | ||
- type: input | ||
id: contact | ||
attributes: | ||
label: Contact Details | ||
description: How can we get in touch with you if we need more info? | ||
placeholder: ex. [email protected] | ||
validations: | ||
required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
name: Unclassified Issue | ||
description: Open an issue | ||
title: "[Unclassified]: " | ||
labels: ["unclassified", "triage"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: Please open a Feature Request, Docs, or Bug Report issue, but if none of those are applicable you can use this generic form. | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Issue Description | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: By submitting this issue, you agree to follow our [Code of Conduct](../../../CODE_OF_CONDUCT.md). | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true |