From 2dd0819ddd90b22919efb8aa32a79a0461dc47bc Mon Sep 17 00:00:00 2001 From: Dhruv Patel <47289182+d-k-patel@users.noreply.github.com> Date: Thu, 21 Aug 2025 12:03:26 +0530 Subject: [PATCH] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 59 ++++++++++++----------- .github/ISSUE_TEMPLATE/documentation.md | 5 +- .github/ISSUE_TEMPLATE/feature_request.md | 35 ++++---------- 3 files changed, 42 insertions(+), 57 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 79548ff..dd84ea7 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,37 +1,38 @@ --- name: Bug report about: Create a report to help us improve -title: '[BUG] ' -labels: ['bug', 'needs-triage'] +title: '' +labels: '' assignees: '' + --- -## Bug Description +**Describe the bug** A clear and concise description of what the bug is. -## Steps to Reproduce -1. Run command: `aiclip "..."` -2. See error: `...` -3. Expected behavior: `...` - -## Environment -- **OS**: [e.g., macOS 14.0, Ubuntu 22.04, Windows 11] -- **Python version**: [e.g., 3.10.0] -- **aiclip version**: [e.g., 0.2.2] -- **ffmpeg version**: [e.g., 6.0] - -## Error Details -``` -# Paste the full error message here -``` - -## Additional Context -- What were you trying to accomplish? -- Any relevant files or configurations? -- Does this happen with all inputs or specific ones? - -## Checklist -- [ ] I've searched existing issues for duplicates -- [ ] I've provided all required environment details -- [ ] I've included the exact command that caused the issue -- [ ] I've checked that ffmpeg is properly installed and accessible +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md index 87c3215..575381d 100644 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -1,9 +1,10 @@ --- name: Documentation improvement about: Suggest improvements to documentation -title: '[DOCS] ' -labels: ['documentation', 'good first issue'] +title: "[DOCS] " +labels: documentation, good first issue assignees: '' + --- ## Documentation Area diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 5070615..bbcbbe7 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,37 +1,20 @@ --- name: Feature request about: Suggest an idea for this project -title: '[FEATURE] ' -labels: ['enhancement', 'needs-triage'] +title: '' +labels: '' assignees: '' + --- -## Problem Statement -A clear and concise description of what problem this feature would solve. +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -## Proposed Solution +**Describe the solution you'd like** A clear and concise description of what you want to happen. -## Use Cases -- **Primary use case**: [e.g., "Batch processing multiple video files"] -- **Secondary use cases**: [e.g., "Integration with CI/CD pipelines"] - -## Example Usage -```bash -# How you envision using this feature -aiclip "your proposed command here" -``` - -## Alternative Solutions +**Describe alternatives you've considered** A clear and concise description of any alternative solutions or features you've considered. -## Additional Context -- Is this feature related to a specific workflow? -- Would this be a breaking change? -- Any performance considerations? - -## Checklist -- [ ] I've searched existing issues for similar requests -- [ ] This feature aligns with the project's safety-first approach -- [ ] I've provided clear use cases and examples -- [ ] I understand this may not be implemented immediately +**Additional context** +Add any other context or screenshots about the feature request here.