diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..9974c9c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,69 @@ +name: Bug Report +description: Report a bug or unexpected behavior +title: "[Bug]: " +labels: ["bug", "triage"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report this bug! + + - type: textarea + id: description + attributes: + label: Bug Description + description: What happened? + placeholder: A clear and concise description of the bug + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: What did you expect to happen? + placeholder: Describe what you expected to happen + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Steps to Reproduce + description: How can we reproduce this issue? + value: | + 1. + 2. + 3. + 4. + validations: + required: true + + - type: textarea + id: environment + attributes: + label: Environment + description: Please provide relevant environment details + value: | + - OS: [e.g., Ubuntu 22.04] + - Go Version: [e.g., 1.23] + - Project Version/Commit: [e.g., v1.0.0 or commit hash] + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Relevant Logs + description: Please copy and paste any relevant log output + render: shell + validations: + required: false + + - type: textarea + id: additional + attributes: + label: Additional Context + description: Add any other context about the problem here + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..dc90c8f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,17 @@ +blank_issues_enabled: false +template_chooser: + types: + - name: 🐛 Bug Report + filename: bug_report.md + description: Report a reproducible bug or issue + labels: ["bug", "triage"] + + - name: 💡 Feature Request + filename: feature_request.md + description: Suggest a new feature or enhancement + labels: ["enhancement", "triage"] + + - name: ❓ Question + filename: question.md + description: Ask a question about this project + labels: ["question"] \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 5adbad9..820da26 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,41 +1,95 @@ -# Feature Request Template - -## Summary - - -## Motivation - -- **Problem**: What problem does this solve? -- **Impact**: Who will benefit from this feature? -- **Context**: How does this relate to existing features? - -## Detailed Proposal - - -### Use Cases - -1. -2. - -### Technical Details - -- **Scope**: -- **Dependencies**: -- **Implementation ideas**: - -### Potential Challenges - -- -- - -## Alternatives Considered - -1. Alternative A - - Pros: - - Cons: -2. Alternative B - - Pros: - - Cons: - -## Additional Context - +name: Feature Request +description: Suggest a new feature or enhancement +title: "[Feature]: " +labels: ["enhancement", "triage"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to propose a new feature! + + - type: textarea + id: summary + attributes: + label: Summary + description: A clear and concise description of the feature you're requesting + placeholder: Briefly describe your feature request in 2-3 sentences + validations: + required: true + + - type: textarea + id: motivation + attributes: + label: Motivation + description: Why should this feature be implemented? + value: | + **Problem**: + + + **Impact**: + + + **Context**: + + validations: + required: true + + - type: textarea + id: use-cases + attributes: + label: Use Cases + description: List specific examples of how and when this feature would be used + placeholder: | + 1. + 2. + validations: + required: true + + - type: textarea + id: technical-details + attributes: + label: Technical Details + description: Provide technical specifications or implementation ideas + value: | + **Scope**: + + **Dependencies**: + + **Implementation ideas**: + validations: + required: false + + - type: textarea + id: challenges + attributes: + label: Potential Challenges + description: List any concerns, technical limitations, or other challenges + placeholder: | + - + - + validations: + required: false + + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: What other approaches have you considered? + value: | + 1. Alternative A + - Pros: + - Cons: + + 2. Alternative B + - Pros: + - Cons: + validations: + required: false + + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Add any other context, mockups, or screenshots about the feature request + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..75cf42c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,54 @@ +name: Question +description: Ask a question about this project +title: "[Question]: " +labels: ["question"] +body: + - type: markdown + attributes: + value: | + Thanks for your interest in this project! Before asking your question, please: + - Check the documentation + - Search existing issues + - Check if your question has already been answered in discussions + + - type: textarea + id: question + attributes: + label: Your Question + description: What would you like to know? + placeholder: Please be as specific as possible + validations: + required: true + + - type: textarea + id: context + attributes: + label: Context + description: What are you trying to accomplish? This will help us provide a more helpful answer + placeholder: Provide any additional context that might help us understand your question better + validations: + required: true + + - type: textarea + id: research + attributes: + label: What have you tried? + description: What documentation have you read or solutions have you attempted? + placeholder: | + - Documentation consulted + - Solutions attempted + - Related issues/discussions checked + validations: + required: false + + - type: textarea + id: environment + attributes: + label: Environment (if relevant) + description: Please provide relevant environment details if your question is technical + value: | + - OS: [e.g., Ubuntu 22.04] + - Go Version: [e.g., 1.23] + - Project Version: [e.g., v1.0.0] + validations: + required: false \ No newline at end of file