From 427b064af1c822533bb7f04e02af70857f5619eb Mon Sep 17 00:00:00 2001 From: Steve Dogiakos Date: Sat, 16 May 2026 08:36:55 -0600 Subject: [PATCH] chore: add GitHub issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 35 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 22 ++++++++++++++ .github/ISSUE_TEMPLATE/documentation.md | 23 +++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 23 +++++++++++++++ .github/ISSUE_TEMPLATE/general_report.md | 15 ++++++++++ 5 files changed, 118 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/general_report.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..35574b2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,35 @@ +--- +name: Bug Report +about: Report a bug in the system +title: "[Bug]: " +labels: bug +assignees: '' +--- + +### Description + +A clear and concise description of the bug. + +### Steps to Reproduce + +1. Go to '...' +2. Click on '...' +3. See the error. + +### Expected Behavior + +Explain what you expected to happen. + +### Screenshots + +Add screenshots if applicable. + +### Environment + +- OS: [e.g., Windows, macOS, Linux] +- Browser: [e.g., Chrome, Firefox] +- Version: [e.g., 1.0.0] + +### Additional Context + +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..c8e849c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,22 @@ +blank_issues_enabled: false +issue_templates: + - name: "Bug Report" + description: "Report a bug in the system." + title: "[Bug]: " + labels: ["bug"] + body: "./ISSUE_TEMPLATE/bug_report.md" + - name: "Feature Request" + description: "Propose a new feature or improvement." + title: "[Feature]: " + labels: ["enhancement"] + body: "./ISSUE_TEMPLATE/feature_request.md" + - name: "Documentation" + description: "Suggest updates or additions to the documentation." + title: "[Docs]: " + labels: ["documentation"] + body: "./ISSUE_TEMPLATE/documentation.md" + - name: "General Report" + description: "Provide general feedback or inquiries." + title: "[General]: " + labels: ["general"] + body: "./ISSUE_TEMPLATE/general_report.md" \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000..5a38507 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,23 @@ +-- +name: Documentation +about: Suggest updates or additions to documentation +title: "[Docs]: " +labels: documentation +assignees: '' +--- + +### Documentation Update + +What part of the documentation needs to be updated or added? + +### Why Is This Needed? + +Explain the importance of this update. + +### Suggested Changes + +Provide a detailed description of the changes. + +### Additional Context + +Include any related resources. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..0740baf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,23 @@ +--- +name: Feature Request +about: Suggest a new feature or improvement +title: "[Feature]: " +labels: enhancement +assignees: '' +--- + +### Feature Description + +What feature would you like to see? + +### Why Is This Needed? + +Explain the problem or need for this feature. + +### Suggested Solutions + +Describe how this feature could be implemented. + +### Additional Context + +Add any relevant screenshots, links, or resources. diff --git a/.github/ISSUE_TEMPLATE/general_report.md b/.github/ISSUE_TEMPLATE/general_report.md new file mode 100644 index 0000000..c1236a6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/general_report.md @@ -0,0 +1,15 @@ +--- +name: General Report +about: Provide general feedback or inquiries +title: "[General]: " +labels: general +assignees: '' +--- + +### Feedback or Inquiry + +Provide your feedback or inquiry. + +### Additional Information + +Add any other relevant details here.