From eff227175231db6a18d5e33b81c974709188bb78 Mon Sep 17 00:00:00 2001 From: Ben Date: Sun, 23 Aug 2026 12:51:45 -0400 Subject: [PATCH] Improve issue and PR categories Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.md | 35 ------------ .github/ISSUE_TEMPLATE/bug_report.yml | 64 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 2 + .github/ISSUE_TEMPLATE/documentation.yml | 35 ++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 24 -------- .github/ISSUE_TEMPLATE/feature_request.yml | 53 ++++++++++++++++++ .github/ISSUE_TEMPLATE/question.yml | 35 ++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 25 +++++++-- 8 files changed, 210 insertions(+), 63 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 1e3e605..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -## Summary - -Describe the incorrect behavior and its user impact. - -## Reproduction - -1. -2. -3. - -## Expected Behavior - -## Actual Behavior - -## Environment - -- Package version or commit: -- Python version: -- Operating system: - -## Acceptance Criteria - -- [ ] The expected behavior is restored. -- [ ] A regression test covers the reported behavior. - -## Additional Context diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..e18c49d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,64 @@ +name: Bug report +description: Report reproducible behavior that is incorrect or unexpected. +title: "[Bug]: " +labels: + - bug +body: + - type: markdown + attributes: + value: | + Search existing issues before reporting a bug. Do not report security + vulnerabilities here; follow the instructions in SECURITY.md instead. + + - type: textarea + id: summary + attributes: + label: What happened? + description: Describe the incorrect behavior and its impact. + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: How can we reproduce it? + description: Provide the smallest reliable example and exact steps. + placeholder: | + 1. Install ... + 2. Run ... + 3. Observe ... + validations: + required: true + + - type: textarea + id: expected + attributes: + label: What did you expect? + validations: + required: true + + - type: textarea + id: environment + attributes: + label: Environment + description: Include the package version or commit, Python version, and operating system. + placeholder: | + Package version or commit: + Python version: + Operating system: + validations: + required: true + + - type: textarea + id: context + attributes: + label: Additional context + description: Add logs, tracebacks, screenshots, or other useful details. + + - type: checkboxes + id: checks + attributes: + label: Before submitting + options: + - label: I searched for an existing issue that describes this problem. + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..8005e32 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,2 @@ +blank_issues_enabled: false +contact_links: [] diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 0000000..80efe5c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,35 @@ +name: Documentation improvement +description: Report missing, unclear, or incorrect documentation. +title: "[Docs]: " +labels: + - documentation +body: + - type: input + id: location + attributes: + label: Where is the documentation problem? + description: Link to the page or name the file and section. + validations: + required: true + + - type: textarea + id: problem + attributes: + label: What needs improvement? + description: Explain what is missing, unclear, or incorrect. + validations: + required: true + + - type: textarea + id: suggestion + attributes: + label: Suggested change + description: Describe or draft the improvement if you have one. + + - type: checkboxes + id: checks + attributes: + label: Before submitting + options: + - label: I checked the current documentation and existing issues. + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 0fe8373..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -## Problem - -Describe the user need or limitation this request addresses. - -## Proposed Change - -## Alternatives Considered - -## Acceptance Criteria - -- [ ] - -## Documentation and Release Notes - -Describe expected documentation or changelog impact. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..ad21910 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,53 @@ +name: Feature request +description: Suggest a new capability or an improvement to existing behavior. +title: "[Feature]: " +labels: + - enhancement +body: + - type: markdown + attributes: + value: | + Start with the user need rather than a specific implementation. + + - type: textarea + id: problem + attributes: + label: What problem would this solve? + description: Explain who has the problem and why the current behavior is insufficient. + validations: + required: true + + - type: textarea + id: proposal + attributes: + label: What would you like to happen? + description: Describe the desired behavior. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: What alternatives have you considered? + description: Include current workarounds when applicable. + + - type: textarea + id: success + attributes: + label: How will we know this is complete? + description: List the outcomes or acceptance criteria that matter. + validations: + required: true + + - type: textarea + id: context + attributes: + label: Additional context + + - type: checkboxes + id: checks + attributes: + label: Before submitting + options: + - label: I searched for an existing request that covers this idea. + required: true diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..2386cbd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,35 @@ +name: Question +description: Ask for help when the documentation does not answer your question. +title: "[Question]: " +labels: + - question +body: + - type: textarea + id: question + attributes: + label: What do you need help with? + description: Ask a specific question and describe what you are trying to accomplish. + validations: + required: true + + - type: textarea + id: attempted + attributes: + label: What have you tried? + description: Include relevant documentation, code, commands, or error messages. + validations: + required: true + + - type: textarea + id: environment + attributes: + label: Environment + description: Include version and platform details when relevant. + + - type: checkboxes + id: checks + attributes: + label: Before submitting + options: + - label: I searched the documentation and existing issues first. + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 39bc271..85ffc86 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,16 +2,33 @@ Describe the user-facing problem and the change that addresses it. -## Acceptance Criteria +## Related Issue -- [ ] The behavior matches the issue or request. -- [ ] Relevant edge cases are covered. +Link the issue this change addresses, such as `Closes #123`. + +## Category + +Select one primary category. + +- [ ] Bug fix +- [ ] Feature +- [ ] Documentation +- [ ] Maintenance or refactor +- [ ] Dependency update + +## Compatibility + +- [ ] This change is backward compatible. +- [ ] This change deprecates existing behavior. +- [ ] This change breaks existing behavior. ## Validation List the commands run and their results. -## Documentation and Release Notes +## Checklist +- [ ] Tests cover the change, or no new tests are needed. +- [ ] Relevant edge cases are covered. - [ ] Documentation is updated, or no update is needed. - [ ] `CHANGELOG.md` is updated for a user-facing, compatibility, or security change.