From 9e1e7aa824982b0311cf47fdf3b2633b6e624f2e Mon Sep 17 00:00:00 2001 From: awesomejt-work <165930223+awesomejt-work@users.noreply.github.com> Date: Tue, 14 Jan 2025 12:25:16 -0700 Subject: [PATCH] Adding GitHub Issues templates (#33) Co-authored-by: Jason Taylor --- .github/ISSUE_TEMPLATE/config.yaml | 1 + .../ISSUE_TEMPLATE/non-technical-issue.yml | 39 ++++++++++++ .github/ISSUE_TEMPLATE/techIssue.yml | 60 +++++++++++++++++++ 3 files changed, 100 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yaml create mode 100644 .github/ISSUE_TEMPLATE/non-technical-issue.yml create mode 100644 .github/ISSUE_TEMPLATE/techIssue.yml diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml new file mode 100644 index 000000000..3ba13e0ce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/non-technical-issue.yml b/.github/ISSUE_TEMPLATE/non-technical-issue.yml new file mode 100644 index 000000000..c900db60a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/non-technical-issue.yml @@ -0,0 +1,39 @@ +name: 📚 Non-Technical Issue +description: Use this form to submit content suggestions, fixes, and questions as well as any other non-technical topic. +title: "Non-Technical Issue:" + +body: +- type: dropdown + id: issueLoc + attributes: + label: Issue Location + description: "Where is this issue located?" + options: + - javadocs + - README file + - Other + validations: + required: true +- type: dropdown + id: issueTypeN + attributes: + label: "Issue Type" + description: "What type of issue is this?" + options: + - Content addition + - Content correction + - Question + - Typo, syntax, or other minor fixes + - Other +- type: textarea + id: description + attributes: + label: "Issue Description" + description: "Use the area below to concisely describe the issue, including any necessary links to navigate to the issue location" +- type: checkboxes + id: selfhelp + attributes: + label: Self-Service + description: If you feel like you could contribute to this issue, please check the box below. + options: + - label: I would be willing to fix this issue diff --git a/.github/ISSUE_TEMPLATE/techIssue.yml b/.github/ISSUE_TEMPLATE/techIssue.yml new file mode 100644 index 000000000..9e99a8591 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/techIssue.yml @@ -0,0 +1,60 @@ +name: "💻 Technical Issue" +description: Use this form to report any issue that will involve touching code within this repository +title: "Technical Issue: " + +body: +- type: dropdown + id: issueType + attributes: + label: Issue Type + description: Select the technical issue type that most closely aligns with the issue you wish to report + options: + - Bug + - Accessibility Issue + - Feature Request + - Other Technical Issue + validations: + required: true +- type: textarea + id: expected + attributes: + label: "Expected Behavior" + description: "Clearly and concisely describe what you expect or propose to happen:" +- type: textarea + id: current + attributes: + label: "Current Behavior" + description: "Describe what is currently happening, highlighting the differences between current and expected behavior:" +- type: textarea + id: reproduce + attributes: + label: Steps to Reproduce Issue + description: "Enter the steps to reproduce the error:" + placeholder: | + 1. Go to ... + 2. Click on .... + 3. Scroll down to .... + 4. See error +- type: textarea + id: screenshots + attributes: + label: Screenshots + description: If applicable, add screenshots to help explain your problem. +- type: textarea + id: localEnv + attributes: + label: Local Environment + description: "Please complete the following information:" + value: | + - OS: + - Open JDK Java Version: + - Apache Maven Version: + - [REPO/SOFTWARE] Version: +- type: checkboxes + id: selfhelp + attributes: + label: Self-Service + description: If you feel like you could contribute to this issue, please check the box below. + options: + - label: I would be willing to fix this issue +