From 69586530523bd83c520ada1cb3325b1277e6a24c Mon Sep 17 00:00:00 2001 From: Sean Beckett Date: Tue, 28 May 2024 11:26:14 -0600 Subject: [PATCH] docs: update issue template forms (#21) Signed-off-by: Sean Beckett Co-authored-by: Justin Tieri <37750742+jtieri@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.yml | 33 +++++++++++----------- .github/ISSUE_TEMPLATE/config.yml | 8 ------ .github/ISSUE_TEMPLATE/docs_issue.yml | 20 ++++--------- .github/ISSUE_TEMPLATE/feature_request.yml | 19 ++++--------- .github/ISSUE_TEMPLATE/unclassified.yml | 20 +++++++++++++ 5 files changed, 47 insertions(+), 53 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/unclassified.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 804d537..3ad34ce 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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@example.com - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml deleted file mode 100644 index 678cea7..0000000 --- a/.github/ISSUE_TEMPLATE/config.yml +++ /dev/null @@ -1,8 +0,0 @@ -blank_issues_enabled: false -contact_links: - - name: GitHub Community Support - url: https://github.com/orgs/community/discussions - about: Please ask and answer questions here. - - name: GitHub Security Bug Bounty - url: https://bounty.github.com/ - about: Please report security vulnerabilities here. diff --git a/.github/ISSUE_TEMPLATE/docs_issue.yml b/.github/ISSUE_TEMPLATE/docs_issue.yml index 02f70c8..d497529 100644 --- a/.github/ISSUE_TEMPLATE/docs_issue.yml +++ b/.github/ISSUE_TEMPLATE/docs_issue.yml @@ -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@example.com - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 84b7d54..61892f3 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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@example.com - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/unclassified.yml b/.github/ISSUE_TEMPLATE/unclassified.yml new file mode 100644 index 0000000..da4ab3d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/unclassified.yml @@ -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