From b5caef503bdd9daddd45b4b694a87ff4ddf5a6cc Mon Sep 17 00:00:00 2001 From: Bryan Brooks Date: Sun, 14 Dec 2025 10:43:59 -0600 Subject: [PATCH] Upgrade issue templates to YAML forms - Replace markdown templates with structured YAML forms - Add component dropdowns for bug reports and feature requests - Add security report template for non-critical vulnerabilities - Add issue chooser config disabling blank issues --- .github/ISSUE_TEMPLATE/bug_report.md | 38 ---------- .github/ISSUE_TEMPLATE/bug_report.yml | 80 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 +++ .github/ISSUE_TEMPLATE/feature_request.md | 27 -------- .github/ISSUE_TEMPLATE/feature_request.yml | 65 ++++++++++++++++++ .github/ISSUE_TEMPLATE/security_report.yml | 80 ++++++++++++++++++++++ 6 files changed, 233 insertions(+), 65 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 delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/security_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index faf2e18..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Bug Report -about: Report a bug or unexpected behavior -title: '[BUG] ' -labels: bug -assignees: '' ---- - -## Description - -A clear and concise description of the bug. - -## To Reproduce - -Steps to reproduce the behavior: -1. -2. -3. - -## Expected Behavior - -What you expected to happen. - -## Actual Behavior - -What actually happened. - -## Environment - -- OS: [e.g., Ubuntu 22.04, macOS 14, Windows 11] -- Rust version (if applicable): [e.g., 1.75.0] -- Node.js version (if applicable): [e.g., 20.10.0] -- ATAuth version: [e.g., 0.1.0] -- Component: [Rust library / TypeScript package / Gateway] - -## Additional Context - -Add any other context, logs, or screenshots about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..eb74b85 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,80 @@ +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 form below. + + - type: dropdown + id: component + attributes: + label: Component + description: Which part of ATAuth is affected? + options: + - Rust Library + - TypeScript Library + - Gateway Server + - Documentation + - CI/CD + validations: + required: true + + - type: textarea + id: description + attributes: + label: Bug Description + description: A clear and concise description of what the bug is. + placeholder: Describe the bug... + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Steps to Reproduce + description: How can we reproduce this behavior? + placeholder: | + 1. Configure... + 2. Call... + 3. See error... + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: What did you expect to happen? + validations: + required: true + + - type: textarea + id: environment + attributes: + label: Environment + description: Please provide relevant environment information + placeholder: | + - OS: [e.g., Ubuntu 22.04, macOS 14] + - Rust version: [e.g., 1.75.0] + - Node.js version: [e.g., 20.10.0] + - ATAuth version: [e.g., 1.0.0] + + - type: textarea + id: logs + attributes: + label: Relevant Logs + description: If applicable, add logs or error messages. + render: shell + + - type: checkboxes + id: terms + attributes: + label: Checklist + options: + - label: I have searched existing issues to ensure this is not a duplicate + required: true + - label: I have read the documentation + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..be5e175 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Documentation + url: https://github.com/Cache8063/atauth#readme + about: Check out the documentation before opening an issue + - name: Discussions + url: https://github.com/Cache8063/atauth/discussions + about: Ask questions and discuss ideas diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index f27db5c..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -name: Feature Request -about: Suggest a new feature or enhancement -title: '[FEATURE] ' -labels: enhancement -assignees: '' ---- - -## Problem Statement - -A clear description of the problem or limitation you're experiencing. - -## Proposed Solution - -Describe the solution you'd like to see. - -## Alternatives Considered - -Any alternative solutions or features you've considered. - -## Use Case - -Describe your use case and how this feature would help. - -## Additional Context - -Add any other context, mockups, or examples about the feature request. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..06a3a2f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,65 @@ +name: Feature Request +description: Suggest a new feature or enhancement +title: "[Feature]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thanks for suggesting a new feature! Please fill out the form below. + + - type: dropdown + id: component + attributes: + label: Component + description: Which part of ATAuth would this feature affect? + options: + - Rust Library + - TypeScript Library + - Gateway Server + - Documentation + - CI/CD + - New Component + validations: + required: true + + - type: textarea + id: problem + attributes: + label: Problem Statement + description: What problem does this feature solve? What use case does it address? + placeholder: I'm trying to... but currently... + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: Describe the solution you'd like to see implemented. + placeholder: It would be great if... + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: Have you considered any alternative solutions or workarounds? + placeholder: I also considered... + + - type: textarea + id: additional + attributes: + label: Additional Context + description: Add any other context, mockups, or examples about the feature request. + + - type: checkboxes + id: terms + attributes: + label: Checklist + options: + - label: I have searched existing issues to ensure this is not a duplicate + required: true + - label: I have read the documentation + required: true diff --git a/.github/ISSUE_TEMPLATE/security_report.yml b/.github/ISSUE_TEMPLATE/security_report.yml new file mode 100644 index 0000000..0e9ceec --- /dev/null +++ b/.github/ISSUE_TEMPLATE/security_report.yml @@ -0,0 +1,80 @@ +name: Security Report +description: Report a security vulnerability (for non-critical issues) +title: "[Security]: " +labels: ["security"] +body: + - type: markdown + attributes: + value: | + Thank you for reporting a security issue. For critical vulnerabilities, please email the maintainers directly instead of opening a public issue. + + - type: dropdown + id: severity + attributes: + label: Severity + description: How severe is this security issue? + options: + - Low - Minor issue with limited impact + - Medium - Moderate impact, workaround available + - High - Significant impact, no easy workaround + validations: + required: true + + - type: dropdown + id: component + attributes: + label: Affected Component + description: Which part of ATAuth is affected? + options: + - Rust Library + - TypeScript Library + - Gateway Server + - Dependencies + - CI/CD + validations: + required: true + + - type: textarea + id: description + attributes: + label: Vulnerability Description + description: Describe the security issue. Be specific but avoid including exploit code. + placeholder: The issue is... + validations: + required: true + + - type: textarea + id: impact + attributes: + label: Potential Impact + description: What could an attacker do by exploiting this vulnerability? + placeholder: An attacker could... + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Steps to Reproduce + description: How can we verify this vulnerability exists? + placeholder: | + 1. Configure... + 2. Send request... + 3. Observe... + + - type: textarea + id: mitigation + attributes: + label: Suggested Mitigation + description: If you have ideas for how to fix this, please share them. + placeholder: This could be fixed by... + + - type: checkboxes + id: terms + attributes: + label: Checklist + options: + - label: I have verified this is not a critical vulnerability that should be reported privately + required: true + - label: I have searched existing issues to ensure this is not a duplicate + required: true -- knotmirror 0.0.1