From caca2b0fc607e2d387bc804c0376df09c0bab5d9 Mon Sep 17 00:00:00 2001 From: Hayden MacIntyre Date: Sun, 15 Feb 2026 23:03:37 -0500 Subject: [PATCH] chore: migrate to new GitHub issue template workflow Replace the old single ISSUE_TEMPLATE.md with YAML-based issue forms under .github/ISSUE_TEMPLATE/ for bug reports, feature requests, and questions. Co-authored-by: Cursor --- .github/ISSUE_TEMPLATE.md | 30 -------- .github/ISSUE_TEMPLATE/bug_report.yml | 79 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature_request.yml | 50 ++++++++++++++ .github/ISSUE_TEMPLATE/question.yml | 34 ++++++++++ 5 files changed, 164 insertions(+), 30 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 9c26666..0000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,30 +0,0 @@ -## What type of issue is this? -- [ ] Bug report -- [ ] Feature request -- [ ] Question -- [ ] Other (please describe below) - -## Description -_A clear and concise description of what the issue is or what you are requesting._ - -## Steps to Reproduce (for bugs) -1. -2. -3. - -## Expected Behavior -_What did you expect to happen?_ - -## Actual Behavior (for bugs) -_What actually happened?_ - -## Screenshots or Logs (if applicable) -_Add screenshots, error messages, or logs to help explain your problem._ - -## Additional Context -_Add any other context about the problem or request here._ - -## Environment (please complete the following information if relevant) -- OS: [e.g. Windows, Mac, Linux] -- Python version: [e.g. 3.10] -- Other dependencies: diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..176ddf9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,79 @@ +name: Bug Report +description: Report a bug or unexpected behavior +title: "[Bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report a bug! Please fill out the information below. + + - type: textarea + id: description + attributes: + label: Description + description: A clear and concise description of the bug. + placeholder: Describe the bug... + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. ... + 2. ... + 3. ... + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: What did you expect to happen? + validations: + required: true + + - type: textarea + id: actual-behavior + attributes: + label: Actual Behavior + description: What actually happened? + validations: + required: true + + - type: textarea + id: screenshots-logs + attributes: + label: Screenshots or Logs + description: Add screenshots, error messages, or logs to help explain the problem. + placeholder: Paste screenshots or logs here... + validations: + required: false + + - type: input + id: os + attributes: + label: Operating System + placeholder: e.g. Windows 11, macOS 14, Ubuntu 22.04 + validations: + required: false + + - type: input + id: python-version + attributes: + label: Python Version + placeholder: e.g. 3.10 + validations: + required: false + + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Add any other context about the problem here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..0086358 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..b8265b3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,50 @@ +name: Feature Request +description: Suggest a new feature or enhancement +title: "[Feature]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thanks for suggesting a feature! Please describe what you'd like to see. + + - type: textarea + id: description + attributes: + label: Description + description: A clear and concise description of the feature you are requesting. + placeholder: Describe the feature... + validations: + required: true + + - type: textarea + id: motivation + attributes: + label: Motivation + description: Why would this feature be useful? What problem does it solve? + validations: + required: false + + - type: textarea + id: proposed-solution + attributes: + label: Proposed Solution + description: If you have an idea of how this could be implemented, describe it here. + validations: + required: false + + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: Have you considered any alternative solutions or workarounds? + validations: + required: false + + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Add any other context, screenshots, or references about the feature request here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..34034ea --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,34 @@ +name: Question +description: Ask a question or request help +title: "[Question]: " +labels: ["question"] +body: + - type: markdown + attributes: + value: | + Have a question? Let's get it answered! + + - type: textarea + id: question + attributes: + label: Question + description: What would you like to know? + placeholder: Describe your question... + validations: + required: true + + - type: textarea + id: context + attributes: + label: Context + description: Any additional context that might help answer your question. + validations: + required: false + + - type: textarea + id: what-you-tried + attributes: + label: What You've Tried + description: If applicable, describe what you've already tried. + validations: + required: false