Skip to content
Draft
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
146 changes: 146 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
name: 🐛 Bug Report
description: File a bug report to help us improve
title: "[Bug]: "
labels: ["bug", "triage"]
assignees:
- ZanderCowboy

body:
- type: markdown
attributes:
value: |
## 🐛 Bug Report

Thank you for taking the time to report a bug! Please fill out this form as completely as possible.

> **Tip**: Before submitting, check if a similar bug report already exists.

- type: input
id: summary
attributes:
label: 📋 Bug Summary
description: A clear and concise description of what the bug is
placeholder: "Example: App crashes when trying to add a new entry with special characters"
validations:
required: true

- type: textarea
id: reproduction-steps
attributes:
label: 🔄 Steps to Reproduce
description: Step-by-step instructions to reproduce the bug
placeholder: |
1. Open the app
2. Navigate to '...'
3. Click on '...'
4. See error
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: ✅ Expected Behavior
description: What you expected to happen
placeholder: "The entry should be added successfully without any crashes."
validations:
required: true

- type: textarea
id: actual-behavior
attributes:
label: ❌ Actual Behavior
description: What actually happened instead
placeholder: "The app crashes and returns to the home screen."
validations:
required: true

- type: dropdown
id: platform
attributes:
label: 📱 Platform
description: Which platform are you using?
options:
- Android
- iOS
- Web
- Windows
- macOS
- Linux
multiple: true
validations:
required: true

- type: input
id: app-version
attributes:
label: 📦 App Version
description: What version of the app are you running?
placeholder: "Example: 1.2.3+45"
validations:
required: true

- type: dropdown
id: severity
attributes:
label: 🚨 Severity Level
description: How severe is this bug?
options:
- "🔥 Critical - App unusable/crashes"
- "🚨 High - Major feature broken"
- "⚠️ Medium - Feature partially works"
- "🔧 Low - Minor issue/cosmetic"
validations:
required: true

- type: textarea
id: device-info
attributes:
label: 📱 Device Information
description: Information about your device
placeholder: |
- Device: (e.g., Pixel 7, iPhone 14)
- OS Version: (e.g., Android 13, iOS 16.1)
- Flutter Version: (if applicable)
render: markdown
validations:
required: false

- type: textarea
id: logs
attributes:
label: 📄 Error Logs/Screenshots
description: Any relevant logs, error messages, or screenshots
placeholder: |
```
Paste error logs here
```

Or drag and drop screenshots here
render: shell
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: 📝 Additional Context
description: Any other context about the problem
placeholder: "This bug started happening after updating to version X.X.X"
validations:
required: false

- type: checkboxes
id: checklist
attributes:
label: ✅ Pre-submission Checklist
description: Please verify the following before submitting
options:
- label: I have searched for existing issues
required: true
- label: I have provided steps to reproduce
required: true
- label: I have included relevant device/version information
required: true
- label: I am willing to help test the fix
required: false
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
blank_issues_enabled: true
contact_links:
- name: 💬 Discussions
url: https://github.com/ZanderCowboy/multichoice/discussions
about: Ask questions, share ideas, and discuss the project with the community
- name: 🔒 Security Issues
url: https://github.com/ZanderCowboy/multichoice/security/advisories/new
about: Report security vulnerabilities privately
- name: 📱 Google Play Store
url: https://play.google.com/store/apps/details?id=co.za.zandercowboy.multichoice
about: Rate and review the app on Google Play Store
- name: 📊 Project Roadmap
url: https://github.com/ZanderCowboy/multichoice/projects
about: View our development roadmap and project milestones
182 changes: 182 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,182 @@
name: 📚 Documentation
description: Improve or request documentation
title: "[Docs]: "
labels: ["documentation", "good first issue"]
assignees:
- ZanderCowboy

body:
- type: markdown
attributes:
value: |
## 📚 Documentation Request

Help us improve our documentation! Whether it's fixing typos, adding examples, or creating new guides.

> **Perfect for first-time contributors!**

- type: input
id: doc-title
attributes:
label: 📝 Documentation Title
description: What documentation needs attention?
placeholder: "Example: Add setup instructions for development environment"
validations:
required: true

- type: dropdown
id: doc-type
attributes:
label: 📂 Documentation Type
description: What type of documentation is this?
options:
- "📖 README Updates"
- "🚀 Getting Started Guide"
- "💻 API Documentation"
- "🏗️ Architecture Documentation"
- "🧪 Testing Guide"
- "🔧 Configuration Guide"
- "📱 User Guide"
- "🎯 Contributing Guide"
- "❓ FAQ"
- "🐛 Troubleshooting"
- "📝 Code Comments"
- "✨ Other"
validations:
required: true

- type: textarea
id: current-state
attributes:
label: 📄 Current State
description: What's wrong with the current documentation (if any)?
placeholder: |
- Missing information about...
- Outdated instructions for...
- Confusing explanation of...
- No documentation exists for...
validations:
required: true

- type: textarea
id: proposed-improvement
attributes:
label: ✨ Proposed Improvement
description: What should be added, changed, or improved?
placeholder: |
- Add section about...
- Update instructions to include...
- Clarify the explanation of...
- Create examples for...
validations:
required: true

- type: dropdown
id: target-audience
attributes:
label: 👥 Target Audience
description: Who is this documentation for?
options:
- "🌱 New contributors"
- "💻 Developers"
- "👤 End users"
- "🔧 Maintainers"
- "🏢 Enterprise users"
- "📚 Everyone"
validations:
required: true

- type: textarea
id: affected-files
attributes:
label: 📁 Affected Files/Sections
description: Which files or sections need updates?
placeholder: |
- README.md (section: Getting Started)
- docs/contributing.md
- lib/src/services/README.md
- Code comments in auth_service.dart
validations:
required: false

- type: textarea
id: content-outline
attributes:
label: 📋 Content Outline
description: Provide an outline or draft of the content (if applicable)
placeholder: |
## Section Title
1. Introduction
2. Prerequisites
3. Step-by-step instructions
4. Examples
5. Troubleshooting
validations:
required: false

- type: textarea
id: examples-needed
attributes:
label: 💡 Examples Needed
description: What kind of examples would be helpful?
placeholder: |
- Code snippets showing how to...
- Screenshot of the settings page
- Example configuration file
- Sample API response
validations:
required: false

- type: dropdown
id: priority
attributes:
label: 📈 Priority
description: How important is this documentation update?
options:
- "🔥 High - Critical for project usability"
- "⚡ Medium - Would significantly help users"
- "💡 Low - Nice to have improvement"
validations:
required: true

- type: textarea
id: references
attributes:
label: 📖 References
description: Any relevant links, examples from other projects, or resources
placeholder: |
- Similar documentation: https://example.com/docs
- Related issue: #123
- Inspiration from: flutter.dev/docs
validations:
required: false

- type: checkboxes
id: volunteer
attributes:
label: 🙋‍♀️ Contribution Offer
description: Are you willing to help with this documentation?
options:
- label: I can write this documentation
required: false
- label: I can review the documentation once written
required: false
- label: I can provide examples or screenshots
required: false
- label: I can test the instructions for accuracy
required: false
- label: I need help writing this but can collaborate
required: false

- type: checkboxes
id: checklist
attributes:
label: ✅ Pre-submission Checklist
description: Please verify the following before submitting
options:
- label: I have searched for existing documentation issues
required: true
- label: I have clearly identified what needs to be documented
required: true
- label: I have specified who this documentation is for
required: true
Loading
Loading