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
97 changes: 97 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
name: πŸ› Bug Report
description: Create a report to help us improve
title: "[BUG] "
labels: ["bug", "needs-triage"]
assignees: []

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report! Please provide as much detail as possible to help us investigate and resolve the issue.

- 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: steps-to-reproduce
attributes:
label: Steps to Reproduce
description: Steps to reproduce the behavior
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: A clear and concise description of what you expected to happen.
placeholder: What should have happened?
validations:
required: true

- type: textarea
id: actual-behavior
attributes:
label: Actual Behavior
description: A clear and concise description of what actually happened.
placeholder: What actually happened?
validations:
required: true

- type: textarea
id: system-info
attributes:
label: System Information
description: Please provide details about your environment
placeholder: |
- OS: [e.g. Windows 10, macOS 13.1, Ubuntu 22.04]
- Browser: [e.g. Chrome 108, Firefox 107, Safari 16.1]
- Version: [e.g. v1.2.3]
- Node.js version: [e.g. 18.12.1]
- Package manager: [e.g. npm 8.19.2, yarn 1.22.19]
validations:
required: true

- type: textarea
id: logs
attributes:
label: Relevant Log Output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell

- type: textarea
id: screenshots
attributes:
label: Screenshots/Videos
description: If applicable, add screenshots or videos to help explain your problem.

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context about the problem here, such as related issues, workarounds, or potential solutions you've tried.

- type: checkboxes
id: verification
attributes:
label: Verification
description: Please confirm the following
options:
- label: I have searched for existing issues that describe the same problem
required: true
- label: I have provided all the information requested above
required: true
- label: I am using the latest version of the software
required: false
118 changes: 118 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
name: ✨ Feature Request
description: Suggest an idea for this project
title: "[FEATURE] "
labels: ["enhancement", "needs-triage"]
assignees: []

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to suggest a new feature! Please provide as much detail as possible to help us understand your needs and implement the best solution.

- type: textarea
id: problem-statement
attributes:
label: Problem Statement
description: Is your feature request related to a problem? Please describe the problem you're trying to solve.
placeholder: I'm always frustrated when...
validations:
required: true

- type: textarea
id: motivation
attributes:
label: Motivation
description: Why is this feature important? What use cases does it enable?
placeholder: This feature would help users to...
validations:
required: true

- type: textarea
id: proposed-solution
attributes:
label: Proposed Solution
description: Describe the solution you'd like to see implemented.
placeholder: I would like to see...
validations:
required: true

- type: textarea
id: detailed-design
attributes:
label: Detailed Design (Optional)
description: If you have a specific implementation in mind, please describe it here.
placeholder: |
- API changes:
- UI changes:
- Configuration options:
- Dependencies:

- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: Describe any alternative solutions or features you've considered.
placeholder: Alternative approaches could be...
validations:
required: true

- type: textarea
id: examples
attributes:
label: Examples/Mockups
description: If applicable, provide examples, mockups, or references to similar implementations.

- type: dropdown
id: priority
attributes:
label: Priority
description: How important is this feature to you?
options:
- Low - Nice to have
- Medium - Would improve workflow
- High - Critical for adoption
- Critical - Blocking current work
validations:
required: true

- type: dropdown
id: complexity
attributes:
label: Implementation Complexity (Your Assessment)
description: Based on your understanding, how complex do you think this feature would be to implement?
options:
- Simple - Minor changes
- Medium - Moderate effort
- Complex - Significant changes
- Very Complex - Major architectural changes
- Unknown

- type: textarea
id: acceptance-criteria
attributes:
label: Acceptance Criteria
description: What specific criteria must be met for this feature to be considered complete?
placeholder: |
- [ ] Criterion 1
- [ ] Criterion 2
- [ ] Criterion 3

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context, links, or references about the feature request here.

- type: checkboxes
id: verification
attributes:
label: Verification
description: Please confirm the following
options:
- label: I have searched for existing feature requests that describe the same functionality
required: true
- label: I have provided a clear description of the problem and proposed solution
required: true
- label: I understand this is a request and not a guarantee of implementation
required: true
56 changes: 56 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Pull Request

## Description
<!-- Provide a clear and concise description of the changes made in this PR -->


## Related Issues
<!-- Link any related issues using #issue_number or "Closes #issue_number" -->
- Related to:
- Closes:

## Type of Change
<!-- Mark the relevant option with an "x" -->
- [ ] πŸ› Bug fix (non-breaking change that fixes an issue)
- [ ] ✨ New feature (non-breaking change that adds functionality)
- [ ] πŸ’₯ Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] πŸ“ Documentation update
- [ ] 🎨 Code style update (formatting, renaming)
- [ ] ♻️ Refactoring (no functional changes)
- [ ] ⚑ Performance improvement
- [ ] πŸ”§ Configuration change
- [ ] πŸ§ͺ Test addition or update

## Testing
<!-- Describe the testing you've performed to verify your changes -->
- [ ] I have tested these changes locally
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] I have checked my code doesn't introduce any linting errors

### Test Cases
<!-- List specific test cases or scenarios you've verified -->
1.
2.

## Screenshots/Recordings
<!-- If applicable, add screenshots or recordings to help explain your changes -->


## Deployment Notes
<!-- Any specific deployment instructions or environment considerations -->


## Reviewer Checklist
<!-- For reviewers to complete -->
- [ ] Code follows the project's coding standards and conventions
- [ ] Changes are well-documented and self-explanatory
- [ ] All tests pass and new tests are added where appropriate
- [ ] Security implications have been considered
- [ ] Performance impact has been evaluated
- [ ] Breaking changes are properly documented
- [ ] Documentation has been updated if necessary
- [ ] The PR title and description are clear and accurate

## Additional Context
<!-- Add any other context about the problem or solution here -->
Loading