Skip to content

Commit

Permalink
docs: update issue template forms (#21)
Browse files Browse the repository at this point in the history
Signed-off-by: Sean Beckett <[email protected]>
Co-authored-by: Justin Tieri <[email protected]>
  • Loading branch information
beckettsean and jtieri authored May 28, 2024
1 parent c692534 commit 6958653
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 53 deletions.
33 changes: 16 additions & 17 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
8 changes: 0 additions & 8 deletions .github/ISSUE_TEMPLATE/config.yml

This file was deleted.

20 changes: 5 additions & 15 deletions .github/ISSUE_TEMPLATE/docs_issue.yml
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:
Expand All @@ -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
19 changes: 6 additions & 13 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/unclassified.yml
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

0 comments on commit 6958653

Please sign in to comment.