From f9858aa619bcd672bdcc91df29dda1be2ea80254 Mon Sep 17 00:00:00 2001 From: Sean Beckett Date: Tue, 21 May 2024 12:09:29 -0600 Subject: [PATCH] docs: updating Issue templates to be forms (#13) Co-authored-by: Justin Tieri <37750742+jtieri@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.yml | 37 +++++-------------- .github/ISSUE_TEMPLATE/default.MD | 3 -- .github/ISSUE_TEMPLATE/docs_issue.yml | 41 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.MD | 31 ---------------- .github/ISSUE_TEMPLATE/feature_request.yml | 33 +++++++++++++++++ 5 files changed, 82 insertions(+), 63 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/default.MD create mode 100644 .github/ISSUE_TEMPLATE/docs_issue.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.MD create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 6b372c8..804d537 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -10,14 +10,6 @@ body: attributes: value: | Thanks for taking the time to fill out this bug report! - - 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 - type: textarea id: what-happened attributes: @@ -27,27 +19,6 @@ body: value: "A bug happened!" validations: required: true - - type: dropdown - id: version - attributes: - label: Version - description: What version of our software are you running? - options: - - 1.0.2 (Default) - - 1.0.3 (Edge) - default: 0 - validations: - required: true - - type: dropdown - id: browsers - attributes: - label: What browsers are you seeing the problem on? - multiple: true - options: - - Firefox - - Chrome - - Safari - - Microsoft Edge - type: textarea id: logs attributes: @@ -62,3 +33,11 @@ body: 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/default.MD b/.github/ISSUE_TEMPLATE/default.MD deleted file mode 100644 index 1855eb2..0000000 --- a/.github/ISSUE_TEMPLATE/default.MD +++ /dev/null @@ -1,3 +0,0 @@ -# Default Issue Template stub - -Help on Issue templates: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository diff --git a/.github/ISSUE_TEMPLATE/docs_issue.yml b/.github/ISSUE_TEMPLATE/docs_issue.yml new file mode 100644 index 0000000..02f70c8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs_issue.yml @@ -0,0 +1,41 @@ +name: Docs Issue +description: File a bug report. +title: "[Docs Issue]: " +labels: ["docs", "triage"] +body: + - type: markdown + attributes: + value: Thanks for taking the time to let us know how we can approve the docs! + - type: input + id: docs_page_link + attributes: + label: What page needs improvement? + value: Link a URL if possible + validations: + required: true + - type: textarea + id: description + attributes: + label: Description + description: Please describe the way the docs didn't meet your needs. + - type: textarea + id: remedy + attributes: + label: Remedy + description: Please describe what you think needs to be added or changed for the docs to meet your needs. + - 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). + 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.MD b/.github/ISSUE_TEMPLATE/feature_request.MD deleted file mode 100644 index cfa6436..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.MD +++ /dev/null @@ -1,31 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "" -labels: "" -assignees: "" ---- - -## Is your feature request related to a problem? Please describe. - -> A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -... - -## Describe the solution you'd like - -> A clear and concise description of what you want to happen. - -... - -## Describe alternatives you've considered - -> A clear and concise description of any alternative solutions or features you've considered. - -... - -## Additional context - -> Add any other context or screenshots about the feature request here. - -... diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..84b7d54 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,33 @@ +name: Feature Request +description: Request an enhancement or new feature +title: "[Feature]: " +body: + - type: textarea + id: inspiration + attributes: + label: Inspiration + description: What are you trying to accomplish but finding hard or not possible? + placeholder: What's your end goal? + validations: + required: true + - type: input + id: version + attributes: + label: version + description: What version of the software are you using? + - 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). + 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