Skip to content

Commit

Permalink
Adding GitHub Issues templates (#33)
Browse files Browse the repository at this point in the history
Co-authored-by: Jason Taylor <[email protected]>
  • Loading branch information
awesomejt-work and Jason Taylor authored Jan 14, 2025
1 parent a269e73 commit 9e1e7aa
Show file tree
Hide file tree
Showing 3 changed files with 100 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/non-technical-issue.yml
Original file line number Diff line number Diff line change
@@ -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
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/techIssue.yml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 9e1e7aa

Please sign in to comment.