From 16627636ac1fc69635963327e09afd02e5436bf2 Mon Sep 17 00:00:00 2001 From: Ali Sait Teke Date: Sat, 23 Nov 2024 05:27:31 +0000 Subject: [PATCH 1/2] feat(github): add new issue and discussion templates for better community engagement and contribution guidance --- .github/DISCUSSION_TEMPLATE/general.md | 0 .github/ISSUE_TEMPLATE/documentation.yml | 0 .github/ISSUE_TEMPLATE/feature_request.yml | 0 .github/ISSUE_TEMPLATE/performance.yml | 0 .github/ISSUE_TEMPLATE/security.yml | 0 5 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 .github/DISCUSSION_TEMPLATE/general.md create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/performance.yml create mode 100644 .github/ISSUE_TEMPLATE/security.yml diff --git a/.github/DISCUSSION_TEMPLATE/general.md b/.github/DISCUSSION_TEMPLATE/general.md new file mode 100644 index 0000000..e69de29 diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 0000000..e69de29 diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..e69de29 diff --git a/.github/ISSUE_TEMPLATE/performance.yml b/.github/ISSUE_TEMPLATE/performance.yml new file mode 100644 index 0000000..e69de29 diff --git a/.github/ISSUE_TEMPLATE/security.yml b/.github/ISSUE_TEMPLATE/security.yml new file mode 100644 index 0000000..e69de29 From 09b3443cfaa3a81a57fe81de5974d667cae7eba8 Mon Sep 17 00:00:00 2001 From: Ali Sait Teke Date: Sat, 23 Nov 2024 05:27:37 +0000 Subject: [PATCH 2/2] feat(github-templates): add new issue and discussion templates for better project management and collaboration chore(github-templates): enhance pull request template with detailed sections for clarity and improved review process --- .github/DISCUSSION_TEMPLATE/general.md | 16 +++++ .github/ISSUE_TEMPLATE/documentation.yml | 40 ++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 54 ++++++++++++++++ .github/ISSUE_TEMPLATE/performance.yml | 34 ++++++++++ .github/ISSUE_TEMPLATE/security.yml | 55 ++++++++++++++++ .github/pull_request_template.md | 74 ++++++++++++++++++---- 6 files changed, 259 insertions(+), 14 deletions(-) diff --git a/.github/DISCUSSION_TEMPLATE/general.md b/.github/DISCUSSION_TEMPLATE/general.md index e69de29..567be5d 100644 --- a/.github/DISCUSSION_TEMPLATE/general.md +++ b/.github/DISCUSSION_TEMPLATE/general.md @@ -0,0 +1,16 @@ +## Topic Overview + + +## Background + + +## Questions / Points to Discuss +1. +2. +3. + +## Possible Solutions + + +## Additional Context + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml index e69de29..441971b 100644 --- a/.github/ISSUE_TEMPLATE/documentation.yml +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index e69de29..b727327 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/performance.yml b/.github/ISSUE_TEMPLATE/performance.yml index e69de29..9bf001c 100644 --- a/.github/ISSUE_TEMPLATE/performance.yml +++ b/.github/ISSUE_TEMPLATE/performance.yml @@ -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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/security.yml b/.github/ISSUE_TEMPLATE/security.yml index e69de29..34ddfe1 100644 --- a/.github/ISSUE_TEMPLATE/security.yml +++ b/.github/ISSUE_TEMPLATE/security.yml @@ -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 \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 2cd537d..dc826a9 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,20 +1,66 @@ ## Description - + -## Type of change - -- [ ] Breaking change (major version) -- [ ] New feature (minor version) -- [ ] Bug fix (patch version) -- [ ] Documentation update -- [ ] Dependencies update +## Type of Change + +- [ ] 🚀 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 + + +## Testing + +- [ ] 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 + + +## Additional Notes + ## 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 - \ No newline at end of file + +Closes # \ No newline at end of file