Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
139 changes: 139 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
name: "🐛 Bug Report"
description: "Report a bug to help us improve the project"
title: "[BUG] "
labels: ["bug", "needs-triage"]
assignees: []
body:
- type: markdown
attributes:
value: |
## 🐛 Thanks for reporting a bug!

We appreciate you taking the time to report this issue. Please provide as much detail as possible to help us reproduce and fix the bug quickly.

- type: checkboxes
id: prerequisites
attributes:
label: "Prerequisites"
description: "Please confirm you have completed the following"
options:
- label: "I have searched existing issues to ensure this bug hasn't been reported before"
required: true
- label: "I have updated to the latest version of the project"
required: true
- label: "I have read the troubleshooting documentation"
required: true

- type: textarea
id: bug-description
attributes:
label: "🔍 Bug Description"
description: "Provide a clear and concise description of what the bug is"
placeholder: |
Describe what happened and what you expected to happen:

• What is the current (incorrect) behavior?
• What should the correct behavior be?
• When did this issue start occurring?
validations:
required: true

- type: textarea
id: reproduction-steps
attributes:
label: "🔄 Steps to Reproduce"
description: "Provide detailed steps to reproduce the issue"
placeholder: |
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error

Be as specific as possible. Include any relevant data, inputs, or configuration.
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: "✅ Expected Behavior"
description: "What did you expect to happen?"
placeholder: |
Clearly describe what you expected to happen instead of the bug.
validations:
required: true

- type: textarea
id: actual-behavior
attributes:
label: "❌ Actual Behavior"
description: "What actually happened?"
placeholder: |
Describe what actually happened, including any error messages, unexpected outputs, or incorrect behavior.

- type: dropdown
id: severity
attributes:
label: "🚨 Severity"
description: "How severe is this bug?"
options:
- "Low - Minor issue, workaround available"
- "Medium - Affects functionality but not critical"
- "High - Major functionality broken"
- "Critical - Application unusable or data loss"
validations:
required: true

- type: textarea
id: environment
attributes:
label: "🖥️ Environment Information"
description: "Please provide details about your environment"
placeholder: |
• Operating System: (e.g., Windows 11, macOS 13.0, Ubuntu 22.04)
• Browser: (e.g., Chrome 118, Firefox 119, Safari 17)
• Project Version: (e.g., v1.2.3)
• Node.js Version: (if applicable)
• Other relevant software versions:
render: markdown

- type: textarea
id: error-logs
attributes:
label: "📋 Error Logs"
description: "Include any relevant error messages, stack traces, or console output"
placeholder: |
Paste any error messages, stack traces, or console output here.

```
Error messages go here
```
render: shell

- type: textarea
id: screenshots
attributes:
label: "📸 Screenshots"
description: "Add screenshots to help explain the problem (if applicable)"
placeholder: |
Drag and drop screenshots here, or use the toolbar to upload images.

- type: textarea
id: additional-context
attributes:
label: "📝 Additional Context"
description: "Add any other context about the problem"
placeholder: |
• Does this happen consistently or intermittently?
• Are there any workarounds you've found?
• Any other relevant information that might help us debug this issue?

- type: checkboxes
id: contribution
attributes:
label: "🤝 Contribution"
description: "Are you interested in helping fix this bug?"
options:
- label: "I'm willing to submit a pull request to fix this bug"
- label: "I can help with testing the fix"
- label: "I'm available to provide additional information if needed"
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# GitHub Issue Templates Configuration
# This file configures the behavior of issue creation in this repository

# Enable blank issues (issues created without using a template)
blank_issues_enabled: true

# Default settings for blank issues
blank_issue_title: "Please provide a descriptive title for your issue"
blank_issue_body: |
<!--
Thank you for creating an issue!

Please provide a clear and descriptive title above, and fill out the information below to help us understand and address your concern.
-->

## Description
<!-- Provide a clear and concise description of the issue, question, or topic -->

## Context
<!-- Add any relevant context, environment details, or background information -->

## Additional Information
<!-- Include any screenshots, logs, or other helpful information -->
109 changes: 109 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
---
name: 📚 Documentation
about: Improve documentation, tutorials, or educational content
title: '[DOCS] '
labels: 'documentation, good-first-issue'
assignees: ''

---

# 📚 Documentation Issue

## 📋 Documentation Type
- [ ] 📖 README improvements
- [ ] 🎓 Tutorial/Guide creation
- [ ] 📝 Code documentation (JSDoc)
- [ ] 🔧 Setup/Installation guide
- [ ] 🎯 Algorithm explanations
- [ ] 🌐 API documentation
- [ ] 🎨 UI/UX documentation
- [ ] 🧪 Testing documentation
- [ ] 🚀 Deployment guide
- [ ] ❓ FAQ section

## 🔍 Current State
**What documentation is missing or needs improvement?**
Describe the current state of documentation and what specific areas need attention.

**Target Audience:**
- [ ] 👨‍🎓 New contributors
- [ ] 👩‍💻 Developers
- [ ] 👨‍🏫 Educators
- [ ] 👩‍🎓 Students
- [ ] 🌍 End users

## 💡 Proposed Improvements
**What should be documented?**
- [ ] Step-by-step instructions
- [ ] Code examples
- [ ] Screenshots/diagrams
- [ ] Video tutorials
- [ ] Interactive examples
- [ ] Troubleshooting guide
- [ ] Best practices
- [ ] Performance tips

**Content Structure:**
1. [Section 1: Overview/Introduction]
2. [Section 2: Main content]
3. [Section 3: Examples]
4. [Section 4: Advanced topics]

## 🎯 Participation Information
- [ ] I'm participating in Social Summer of Code (SSOC) Season 4
- [ ] I'm willing to work on this documentation

<!--
The following section will only be shown if you're participating in SSOC Season 4.
Please fill this out if you checked the SSOC participation box above.
-->

<details>
<summary>🏆 SSOC Season 4 Details (Click to expand if participating in SSOC)</summary>

### SSOC Information
**Difficulty Level:**
- [ ] 🟢 Beginner (20 points) - Basic documentation, README updates
- [ ] 🟡 Intermediate (30 points) - Comprehensive guides, tutorials
- [ ] 🔴 Advanced (40 points) - Technical documentation, API docs

**Estimated Time:** [e.g., 1-2 days, 3-5 days, 1 week]

**Skills Required:**
- [ ] Technical writing
- [ ] Markdown
- [ ] Algorithm knowledge
- [ ] React/JavaScript (for code docs)
- [ ] Design (for diagrams/screenshots)
- [ ] Video editing (for tutorials)

**Documentation Plan:**
- **Research Phase**: [Gathering information and requirements]
- **Writing Phase**: [Creating content and examples]
- **Review Phase**: [Proofreading and technical accuracy]
- **Polish Phase**: [Final formatting and publication]

**Mentorship:**
- [ ] I can provide guidance for this documentation
- [ ] I need mentorship for this documentation
- [ ] This can be completed independently

</details>

## 📚 Additional Context
**References:**
- Existing documentation: [links]
- Similar projects: [examples]
- Style guides: [if any]

**Success Criteria:**
- [ ] Clear and concise writing
- [ ] Proper formatting and structure
- [ ] Accurate technical information
- [ ] Helpful examples and screenshots
- [ ] Accessible to target audience

## ✅ Checklist
- [ ] I have identified the specific documentation gap
- [ ] I have considered the target audience
- [ ] I have outlined the proposed content structure
114 changes: 114 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
name: "🚀 Feature Request"
description: "Suggest an idea or enhancement for this project"
title: "[FEATURE] "
labels: ["enhancement", "needs-triage"]
assignees: []
body:
- type: markdown
attributes:
value: |
## 👋 Thanks for taking the time to suggest a feature!

We appreciate your input and want to make sure we understand your needs. Please fill out the sections below to help us evaluate your request.

- type: checkboxes
id: prerequisites
attributes:
label: "Prerequisites"
description: "Please confirm you have completed the following"
options:
- label: "I have searched existing issues to ensure this feature hasn't been requested before"
required: true
- label: "I have read the project documentation and contribution guidelines"
required: true

- type: textarea
id: problem-description
attributes:
label: "🎯 Problem Statement"
description: "What problem does this feature solve? What challenge are you facing?"
placeholder: |
Describe the problem or limitation you're experiencing:

• What are you trying to accomplish?
• What obstacles are preventing you from achieving your goal?
• How does this impact your workflow or user experience?

Example: "I'm always frustrated when I have to manually configure settings for each new project because..."
validations:
required: true

- type: textarea
id: proposed-solution
attributes:
label: "💡 Proposed Solution"
description: "Describe your ideal solution in detail"
placeholder: |
Clearly describe what you'd like to see implemented:

• What should the feature do?
• How should it work from a user's perspective?
• What would the interface/API look like?
• Are there any specific requirements or constraints?
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: "🔄 Alternatives Considered"
description: "What other solutions or workarounds have you considered?"
placeholder: |
Describe any alternative approaches you've thought about:

• Other potential solutions you've considered
• Existing workarounds you're currently using
• Why these alternatives don't fully meet your needs

- type: dropdown
id: priority
attributes:
label: "📊 Priority Level"
description: "How would you rate the importance of this feature?"
options:
- "Low - Nice to have"
- "Medium - Would improve workflow"
- "High - Significant impact on productivity"
- "Critical - Blocking important use cases"
validations:
required: true

- type: textarea
id: use-cases
attributes:
label: "🎭 Use Cases"
description: "Provide specific examples of how this feature would be used"
placeholder: |
Share concrete examples or user stories:

• Who would use this feature?
• In what scenarios would it be useful?
• Can you provide step-by-step examples?

- type: textarea
id: additional-context
attributes:
label: "📎 Additional Context"
description: "Any other information that would help us understand your request"
placeholder: |
Add any other relevant information:

• Screenshots, mockups, or diagrams
• Links to related discussions or documentation
• Examples from other tools or projects
• Technical considerations or constraints

- type: checkboxes
id: contribution
attributes:
label: "🤝 Contribution"
description: "Are you interested in contributing to this feature?"
options:
- label: "I'm willing to submit a pull request for this feature"
- label: "I'm available to help with testing"
- label: "I can provide additional feedback during development"
Loading