From 774c86b1d53925f4b7346e1b19725a2ef5605cd9 Mon Sep 17 00:00:00 2001 From: Nikita Vasilev Date: Sat, 27 Dec 2025 11:16:05 +0400 Subject: [PATCH] chore: add GitHub issue and PR templates --- .github/ISSUE_TEMPLATE/bug_report.md | 41 ---------- .github/ISSUE_TEMPLATE/feature_request.md | 11 --- .github/PULL_REQUEST_TEMPLATE/bug_template.md | 9 --- .../PULL_REQUEST_TEMPLATE/feature_template.md | 12 --- .../workflows/ISSUE_TEMPLATE/bug_report.md | 60 ++++++++++++++ .github/workflows/ISSUE_TEMPLATE/config.yml | 8 ++ .../workflows/ISSUE_TEMPLATE/documentation.md | 55 +++++++++++++ .../ISSUE_TEMPLATE/feature_request.md | 72 +++++++++++++++++ .github/workflows/ISSUE_TEMPLATE/question.md | 37 +++++++++ .github/workflows/PULL_REQUEST_TEMPLATE.md | 81 +++++++++++++++++++ 10 files changed, 313 insertions(+), 73 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/PULL_REQUEST_TEMPLATE/bug_template.md delete mode 100644 .github/PULL_REQUEST_TEMPLATE/feature_template.md create mode 100644 .github/workflows/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/workflows/ISSUE_TEMPLATE/config.yml create mode 100644 .github/workflows/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/workflows/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/workflows/ISSUE_TEMPLATE/question.md create mode 100644 .github/workflows/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 8dc7e75..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -name: "🐛 Bug Report" -about: Report a reproducible bug or regression. -title: 'Bug: ' -labels: 'bug' - ---- - - - -Application version: - -## Steps To Reproduce - -1. -2. - - - -Link to code example: - - - -## The current behavior - - -## The expected behavior \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 5b2f57d..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -name: 🛠 Feature request -about: If you have a feature request for the snacker, file it here. -labels: 'type: enhancement' ---- - -**Feature description** -Clearly and concisely describe the feature. - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/bug_template.md b/.github/PULL_REQUEST_TEMPLATE/bug_template.md deleted file mode 100644 index 7d6a149..0000000 --- a/.github/PULL_REQUEST_TEMPLATE/bug_template.md +++ /dev/null @@ -1,9 +0,0 @@ -## Bug description -Clearly and concisely describe the problem. - -## Solution description -Describe your code changes in detail for reviewers. Explain the technical solution you have provided and how it fixes the issue case. - -## Covered unit test cases -- [x] yes -- [x] no \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/feature_template.md b/.github/PULL_REQUEST_TEMPLATE/feature_template.md deleted file mode 100644 index ab3978b..0000000 --- a/.github/PULL_REQUEST_TEMPLATE/feature_template.md +++ /dev/null @@ -1,12 +0,0 @@ -## Feature description -Clearly and concisely describe the feature. - -## Solution description -Describe your code changes in detail for reviewers. - -## Areas affected and ensured -List out the areas affected by your code changes. - -## Covered unit test cases -- [x] yes -- [x] no \ No newline at end of file diff --git a/.github/workflows/ISSUE_TEMPLATE/bug_report.md b/.github/workflows/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..9fe1610 --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,60 @@ +--- +name: 🐛 Bug Report +about: Report a bug to help us improve +title: '[BUG] ' +labels: bug, needs-triage +assignees: '' +--- + +## Bug Description + + + +## Steps to Reproduce + + + +1. Go to '...' +2. Click on '...' +3. Scroll down to '...' +4. See error + +## Expected Behavior + + + +## Actual Behavior + + + +## Screenshots / Logs + + + +``` + +``` + +## Environment + + + +- **OS**: [e.g., macOS 14.0, iOS 17.0, watchOS 9.0] +- **Version**: [e.g., 1.2.3] + +## Additional Context + + + +## Possible Solution + + + +## Related Issues + + + +--- + +**Priority**: +**Impact**: \ No newline at end of file diff --git a/.github/workflows/ISSUE_TEMPLATE/config.yml b/.github/workflows/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..7966688 --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: 💬 Discussions + url: https://github.com/space-code/snacker/discussions + about: Ask questions and discuss ideas with the community + - name: 📚 Documentation + url: https://github.com/space-code/snacker + about: Read the documentation \ No newline at end of file diff --git a/.github/workflows/ISSUE_TEMPLATE/documentation.md b/.github/workflows/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000..211ec7b --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,55 @@ +--- +name: 📝 Documentation +about: Suggest improvements or report issues in documentation +title: '[DOCS] ' +labels: documentation +assignees: '' +--- + +## Documentation Issue + + + +## Location + + + +**Page/File**: +**Section**: + +## Type of Change + +- [ ] Typo or grammar fix +- [ ] Inaccurate or outdated information +- [ ] Missing documentation +- [ ] Unclear or confusing explanation +- [ ] Code example improvement +- [ ] New documentation needed + +## Current Content + + + +``` + +``` + +## Proposed Changes + + + +``` + +``` + +## Why This Matters + + + +## Additional Context + + + +## Related Issues / PRs + + \ No newline at end of file diff --git a/.github/workflows/ISSUE_TEMPLATE/feature_request.md b/.github/workflows/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..51305eb --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,72 @@ +--- +name: ✨ Feature Request +about: Suggest a new feature or enhancement +title: '[FEATURE] ' +labels: enhancement, needs-triage +assignees: '' +--- + +## Feature Summary + + + +## Motivation + + + +**Is your feature request related to a problem?** + + +## Proposed Solution + + + +## Alternative Solutions + + + +## Use Cases + + + +1. +2. +3. + +## Benefits + + + +- +- +- + +## Implementation Details + + + +``` + +``` + +## Mockups / Examples + + + +## Potential Drawbacks + + + +## Additional Context + + + +## Related Issues / PRs + + + +--- + +**Priority**: +**Effort Estimate**: +**Would you like to implement this feature?**: \ No newline at end of file diff --git a/.github/workflows/ISSUE_TEMPLATE/question.md b/.github/workflows/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..ea999e6 --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/question.md @@ -0,0 +1,37 @@ +--- +name: ❓ Question +about: Ask a question about the project +title: '[QUESTION] ' +labels: question +assignees: '' +--- + +## Question + + + +## Context + + + +## What I've Already Tried + + + +- [ ] Searched existing issues +- [ ] Checked documentation +- [ ] Searched online resources +- [ ] Attempted to solve it myself + +## Related Documentation + + + +## Environment (if applicable) + +- **OS**: +- **Version**: + +## Additional Information + + \ No newline at end of file diff --git a/.github/workflows/PULL_REQUEST_TEMPLATE.md b/.github/workflows/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..3a395de --- /dev/null +++ b/.github/workflows/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,81 @@ +## Description + + + +## Type of Change + + + +- [ ] 🐛 Bug fix (non-breaking change which fixes an issue) +- [ ] ✨ New feature (non-breaking change which adds functionality) +- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] 📝 Documentation update +- [ ] 🎨 Code style update (formatting, renaming) +- [ ] ♻️ Code refactoring (no functional changes) +- [ ] ⚡ Performance improvement +- [ ] ✅ Test update +- [ ] 🔧 Build configuration change +- [ ] 🔒 Security update + +## Related Issues + + + +Fixes # +Related to # + +## Changes Made + + + +- +- +- + +## Screenshots / Videos + + + +## Testing + + + +### Test Configuration + +- **OS**: + +### Test Checklist + +- [ ] Unit tests pass locally +- [ ] Integration tests pass locally +- [ ] Manual testing completed +- [ ] Edge cases covered + +## Checklist + + + +- [ ] My code follows the project's code style guidelines +- [ ] I have performed a self-review of my code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] 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 +- [ ] Any dependent changes have been merged and published + +## Breaking Changes + + + +## Migration Guide + + + +## Additional Notes + + + +--- + +**Reviewers**: @ \ No newline at end of file