From ef33137c82d5f1b7d23c4e79e457eab98c8867a1 Mon Sep 17 00:00:00 2001 From: Siddharth Date: Thu, 27 Nov 2025 15:01:17 +0530 Subject: [PATCH] Adds Issue Template --- .github/ISSUE_TEMPLATE/bug_report.md | 82 ++++++++++++ .github/ISSUE_TEMPLATE/documentation_issue.md | 115 ++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 27 ++++ .github/ISSUE_TEMPLATE/question_support.md | 124 ++++++++++++++++++ .github/pull_request_template.md | 52 ++++++++ 5 files changed, 400 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/documentation_issue.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question_support.md create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..6b3fcb4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,82 @@ +--- +name: Bug Report +about: Create a report to help us improve +title: '[BUG] ' +labels: bug +assignees: '' +--- + +## Bug Description + +A clear and concise description of what the bug is. + +## Reproduction Steps + +1. **Setup Environment** + +```yaml +dependencies: + fastpix_player: 0.1.0 +``` + +2. **Code To Reproduce** + +```dart +FastPixPlayer( controller: controller, + width: 350, + height: 200, + aspectRatio: FastPixAspectRatio.ratio16x9, + showLoadingIndicator: true, + loadingIndicatorColor: Colors.white, + showErrorDetails: false, +) +``` + +3. **Expected Behavior** +``` + +``` + +4. **Actual Behavior** +``` + +``` + +5. **Environment** + +- **SDK Version**: [e.g., 1.2.2] +- **Android Version**: [e.g., Android 12] +- **Min SDK Version**: [e.g., 24] +- **Target SDK Version**: [e.g., 35] +- **Device/Emulator**: [e.g., Pixel 5, Android Emulator] +- **Player**: [e.g., ExoPlayer 2.19.0, VideoView, etc.] +- **Kotlin Version**: [e.g., 2.0.21] + +## Code Sample + +```dart +// Please provide a minimal code sample that reproduces the issue +FastPixPlayer( controller: controller, + width: 350, + height: 200, + aspectRatio: FastPixAspectRatio.ratio16x9, + showLoadingIndicator: true, + loadingIndicatorColor: Colors.white, + showErrorDetails: false, +) +``` + +## Logs/Stack Trace + +``` +Paste relevant logs or stack traces here +``` + +## Additional Context + +Add any other context about the problem here. + +## Screenshots + +If applicable, add screenshots to help explain your problem. + diff --git a/.github/ISSUE_TEMPLATE/documentation_issue.md b/.github/ISSUE_TEMPLATE/documentation_issue.md new file mode 100644 index 0000000..246aa51 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_issue.md @@ -0,0 +1,115 @@ +--- +name: Documentation Issue +about: Report problems with the FastPix Node SDK documentation +title: '[DOCS] ' +labels: ['documentation', 'needs-triage'] +assignees: '' +--- + +# Documentation Issue + +Thank you for helping improve the FastPix Node SDK documentation! Please provide the following information: + +## Issue Type +- [ ] Missing documentation +- [ ] Incorrect information +- [ ] Unclear explanation +- [ ] Broken links +- [ ] Outdated content +- [ ] Other: _______________ + +## Description +**Clear description of the documentation issue:** + + + +## Current Documentation +**What does the current documentation say?** + + + +## Expected Documentation +**What should the documentation say instead?** + + + +## Location +**Where is this documentation issue located?** + +- [ ] README.md +- [ ] docs/ directory +- [ ] USAGE.md +- [ ] CONTRIBUTING.md +- [ ] API documentation +- [ ] Code examples +- [ ] Other: _______________ + +**Specific file and section:** + + +## Impact +**How does this documentation issue affect users?** + +- [ ] Blocks new users from getting started +- [ ] Causes confusion for existing users +- [ ] Leads to incorrect implementation +- [ ] Creates support requests +- [ ] Other: _______________ + +## Proposed Fix +**How would you like this documentation issue to be resolved?** + + +# Correct Documentation + +Here's how the documentation should be written: + +```dart + FastPixPlayer( controller: controller, + width: 350, + height: 200, + aspectRatio: FastPixAspectRatio.ratio16x9, + showLoadingIndicator: true, + loadingIndicatorColor: Colors.white, + showErrorDetails: false, +) +``` + +## Additional Context + +## Screenshots + + +### Related Issues +- **GitHub Issues:** [Link to any related issues] +- **User Feedback:** [Link to user complaints or confusion] + +### Testing +**How did you discover this issue?** + +- [ ] While following the documentation +- [ ] User reported confusion +- [ ] Code didn't work as documented +- [ ] Other: _______________ + +## Priority +Please indicate the priority of this documentation issue: + +- [ ] Critical (Blocks users from using the SDK) +- [ ] High (Causes significant confusion) +- [ ] Medium (Minor clarity issue) +- [ ] Low (Cosmetic improvement) + +## Checklist +Before submitting, please ensure: + +- [ ] I have identified the specific documentation issue +- [ ] I have provided the current and expected content +- [ ] I have explained the impact on users +- [ ] I have proposed a clear fix +- [ ] I have checked if this is already reported +- [ ] I have provided sufficient context + +--- + +**Thank you for helping improve the FastPix Node SDK documentation! 📚** \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..28091de --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,27 @@ +--- +name: Feature Request +about: Suggest an idea for this project +title: '[FEATURE] ' +labels: enhancement +assignees: '' +--- + +## Feature Description +A clear and concise description of the feature you'd like to see. + +## Problem Statement +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 to see implemented. + +## Alternatives Considered +Describe any alternative solutions or features you've considered. + +## Use Case +Describe a specific use case or scenario where this feature would be helpful. + +## Additional Context +Add any other context, mockups, or examples about the feature request here. + diff --git a/.github/ISSUE_TEMPLATE/question_support.md b/.github/ISSUE_TEMPLATE/question_support.md new file mode 100644 index 0000000..e6394a3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question_support.md @@ -0,0 +1,124 @@ +--- +name: Question/Support +about: Ask questions or get help with the FastPix Resumable Uploads SDK +title: '[QUESTION] ' +labels: ['question', 'needs-triage'] +assignees: '' +--- + +# Question/Support + +Thank you for reaching out! We're here to help you with the FastPix Resumable Uploads SDK. Please provide the following information: + +## Question Type +- [ ] How to use a specific feature +- [ ] Integration help +- [ ] Configuration question +- [ ] Performance question +- [ ] Troubleshooting help +- [ ] Other: _______________ + +## Question +**What would you like to know?** + + + +## What You've Tried +**What have you already attempted to solve this?** + +```dart +import 'package:fastpix_player/fastpix_video_player.dart'; + +// Your attempted code here +``` + +## Current Setup +**Describe your current setup:** + +## Environment +- **SDK Version**: [e.g., 1.2.2] +- **Android Version**: [e.g., Android 12] +- **Min SDK Version**: [e.g., 24] +- **Target SDK Version**: [e.g., 35] +- **Device/Emulator**: [e.g., Pixel 5, Android Emulator] +- **Player**: [e.g., ExoPlayer 2.19.0, VideoView, etc.] +- **Kotlin Version**: [e.g., 2.0.21] + +## Configuration +```dart +// Your current SDK configuration (remove sensitive information) +FastPixPlayer( controller: controller, + width: 350, + height: 200, + aspectRatio: FastPixAspectRatio.ratio16x9, + showLoadingIndicator: true, + loadingIndicatorColor: Colors.white, + showErrorDetails: false, +) +``` + +## Expected Outcome +**What are you trying to achieve?** + + + +## Error Messages (if any) +``` + +``` + +## Additional Context + +### Use Case +**What are you building?** + +- [ ] Web application +- [ ] Mobile app (web-based) +- [ ] File upload service +- [ ] Media upload platform +- [ ] Other: _______________ + + +### Timeline +**When do you need this resolved?** + +- [ ] ASAP (blocking development) +- [ ] This week +- [ ] This month +- [ ] No rush + +### Resources Checked +**What resources have you already checked?** + +- [ ] README.md +- [ ] Documentation +- [ ] Examples +- [ ] Stack Overflow +- [ ] GitHub Issues +- [ ] Other: _______________ + +## Priority +Please indicate the urgency: + +- [ ] Critical (Blocking production deployment) +- [ ] High (Blocking development) +- [ ] Medium (Would like to know soon) +- [ ] Low (Just curious) + +## Checklist +Before submitting, please ensure: + +- [ ] I have provided a clear question +- [ ] I have described what I've tried +- [ ] I have included my current setup +- [ ] I have checked existing documentation +- [ ] I have provided sufficient context + +--- + +**We'll do our best to help you get unstuck! 🚀** + +**For urgent issues, please also consider:** +- [FastPix Documentation](https://docs.fastpix.io/) +- [Stack Overflow](https://stackoverflow.com/questions/tagged/fastpix) +- [GitHub Discussions](https://github.com/FastPix/web-uploads-sdk/discussions) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..61b0272 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,52 @@ +# FastPix Resumable Uploads SDK - Documentation PR + +## Documentation Changes + +### What Changed +- [ ] New documentation added +- [ ] Existing documentation updated +- [ ] Documentation errors fixed +- [ ] Code examples updated +- [ ] Links and references updated + +### Files Modified +- [ ] README.md +- [ ] docs/ files +- [ ] USAGE.md +- [ ] CONTRIBUTING.md +- [ ] Other: _______________ + +### Summary +**Brief description of changes:** + + + +### Code Examples +```dart +// If you added/updated code examples, include them here +FastPixPlayer( controller: controller, + width: 350, + height: 200, + aspectRatio: FastPixAspectRatio.ratio16x9, + showLoadingIndicator: true, + loadingIndicatorColor: Colors.white, + showErrorDetails: false, +) +``` + +### Testing +- [ ] All code examples tested +- [ ] Links verified +- [ ] Grammar checked +- [ ] Formatting consistent + +### Review Checklist +- [ ] Content is accurate +- [ ] Code examples work +- [ ] Links are working +- [ ] Grammar is correct +- [ ] Formatting is consistent + +--- + +**Ready for review!**