Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Develop #28

Merged
merged 2 commits into from
Nov 23, 2024
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
16 changes: 16 additions & 0 deletions .github/DISCUSSION_TEMPLATE/general.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
## Topic Overview
<!-- Briefly describe what you'd like to discuss -->

## Background
<!-- Provide any relevant background information -->

## Questions / Points to Discuss
1.
2.
3.

## Possible Solutions
<!-- If applicable, share your thoughts on potential solutions -->

## Additional Context
<!-- Add any other context about the discussion here -->
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Documentation Update
description: Suggest improvements or report issues in documentation
title: "[Docs]: "
labels: ["documentation"]
body:
- type: dropdown
id: type
attributes:
label: Type of Documentation Issue
options:
- Missing Documentation
- Unclear Documentation
- Incorrect Documentation
- Outdated Documentation
- Other
validations:
required: true

- type: input
id: location
attributes:
label: Documentation Location
description: Which part of the documentation needs updating?
placeholder: "README.md, API docs, etc."
validations:
required: true

- type: textarea
id: current
attributes:
label: Current State
description: What does the current documentation say?

- type: textarea
id: suggested
attributes:
label: Suggested Changes
description: What should the documentation say instead?
validations:
required: true
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Feature Request
description: Suggest an idea for this project
title: "[Feature]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to suggest a new feature!

- type: checkboxes
attributes:
label: Prerequisites
options:
- label: I have searched existing issues/PRs to avoid duplicates
required: true
- label: I am willing to help implement this feature
required: false

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

- type: textarea
id: solution
attributes:
label: Proposed Solution
description: Describe the solution you'd like to see
placeholder: "It would be great if..."
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: Describe any alternative solutions you've considered

- type: dropdown
id: importance
attributes:
label: Importance
options:
- Critical
- High
- Medium
- Low
validations:
required: true
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/performance.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Performance Issue
description: Report a performance problem
title: "[Performance]: "
labels: ["performance"]
body:
- type: textarea
id: scenario
attributes:
label: Performance Scenario
description: Describe the scenario where you're experiencing performance issues
validations:
required: true

- type: textarea
id: metrics
attributes:
label: Performance Metrics
description: Share any metrics, benchmarks, or profiling data

- type: input
id: environment
attributes:
label: Environment
description: OS, Node.js version, etc.
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Minimal Reproduction
description: Provide code that demonstrates the performance issue
validations:
required: true
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/security.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Security Issue
description: Report a security vulnerability
title: "[Security]: "
labels: ["security"]
assignees:
- security-team
body:
- type: markdown
attributes:
value: |
🚨 IMPORTANT: For critical security issues, please report via our security policy instead.

- type: dropdown
id: severity
attributes:
label: Severity
options:
- Critical
- High
- Medium
- Low
validations:
required: true

- type: textarea
id: vulnerability
attributes:
label: Vulnerability Description
description: Describe the security issue
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Steps to Reproduce
description: How can we reproduce this vulnerability?
validations:
required: true

- type: input
id: version
attributes:
label: Package Version
description: Which version contains this vulnerability?
validations:
required: true

- type: checkboxes
attributes:
label: Additional Information
options:
- label: This issue includes proof of concept
- label: This vulnerability is already public
- label: I have suggested a mitigation or fix
74 changes: 60 additions & 14 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,66 @@
## Description
<!-- What does this PR do? -->
<!-- Provide a detailed description of your changes -->

## Type of change
<!-- Please delete options that are not relevant -->
- [ ] Breaking change (major version)
- [ ] New feature (minor version)
- [ ] Bug fix (patch version)
- [ ] Documentation update
- [ ] Dependencies update
## Type of Change
<!-- Mark the appropriate option(s) -->
- [ ] 🚀 New Feature (non-breaking change)
- [ ] 🛠️ Bug Fix (non-breaking change)
- [ ] 💥 Breaking Change
- [ ] 📝 Documentation Update
- [ ] 🏗️ Code Refactor
- [ ] 🔧 Performance Improvements
- [ ] ✅ Test Update
- [ ] 🤖 CI/CD Update

## Breaking Changes
<!-- If your PR includes breaking changes, list them here -->

## Testing
<!-- Describe the testing you've done -->
- [ ] Added unit tests
- [ ] Added integration tests
- [ ] Added e2e tests
- [ ] All existing tests pass

## Documentation
- [ ] Updated README.md
- [ ] Updated API documentation
- [ ] Updated CHANGELOG.md
- [ ] Updated JSDoc comments
- [ ] Added code examples

## Performance Impact
- [ ] No performance impact
- [ ] Improved performance
- [ ] Performance regression (justified)

## Security Considerations
- [ ] No security impact
- [ ] Security improvement
- [ ] Requires security review

## Dependencies
- [ ] No dependency changes
- [ ] Added dependencies
- [ ] Removed dependencies
- [ ] Updated dependencies

## Screenshots/Recordings
<!-- If applicable, add screenshots or recordings -->

## Additional Notes
<!-- Any additional information that might be helpful -->

## Checklist
- [ ] I have added tests
- [ ] I have updated documentation
- [ ] I have assigned appropriate labels
- [ ] I have added the change to CHANGELOG.md
- [ ] All tests pass locally
- [ ] My code follows the project's style guidelines
- [ ] I have performed a self-review
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding documentation changes
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix/feature works
- [ ] New and existing unit tests pass locally
- [ ] Any dependent changes have been merged and published

## Related Issues
<!-- Link related issues here -->
<!-- Link related issues here -->
Closes #
Loading