From 8094e582894b5ddfd216d03d82fbbdee16e41544 Mon Sep 17 00:00:00 2001 From: Siddharth Date: Mon, 17 Nov 2025 17:17:30 +0530 Subject: [PATCH 1/3] update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 48 ++++++ .github/ISSUE_TEMPLATE/documentation_issue.md | 0 .github/ISSUE_TEMPLATE/feature_request.md | 27 ++++ .github/ISSUE_TEMPLATE/question_support.md | 152 ++++++++++++++++++ .github/pull_request_template.md | 74 +++++++++ 5 files changed, 301 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..434eb7b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,48 @@ +--- +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. + +## Steps to Reproduce +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. + +## Actual Behavior +A clear and concise description of what actually happened. + +## 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 +```kotlin +// Please provide a minimal code sample that reproduces the issue +``` + +## 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..e69de29 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..51fc2a7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question_support.md @@ -0,0 +1,152 @@ +--- +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?** + +```kotlin +import io.fastpix.data.FastPixDataSDK +import io.fastpix.data.domain.SDKConfiguration +import io.fastpix.data.domain.model.VideoDataDetails +import io.fastpix.data.domain.model.PlayerDataDetails +import io.fastpix.data.domain.model.CustomDataDetails +import io.fastpix.data.domain.listeners.PlayerListener + +// 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 +```kotlin +// Your current SDK configuration (remove sensitive information) +private val fastPixSDK = FastPixDataSDK() + // Create configuration + val config = SDKConfiguration( + workspaceId = "your-workspace-id", + beaconUrl = "custom.beacon.url", // Optional + // Optional + videoData = VideoDataDetails( + videoId = "video-123", + videoTitle = "My Awesome Video", + videoDuration = "300000", // in milliseconds + videoThumbnail = "https://example.com/thumbnail.jpg", + fpPlaybackId = "playback-id" // Optional FastPix playback ID + //.. etc + ), + // Optional + playerData = PlayerDataDetails( + playerName = "ExoPlayer", + playerVersion = "2.19.0" + ), + playerListener = MyPlayerListener(), + enableLogging = true, // Enable for debugging + // Optional + customData = CustomDataDetails( + customField1 = "custom-value-1", + customField2 = "custom-value-2" + //.. etc + ) + ) + + // Initialize SDK + fastPixSDK.initialize(config, applicationContext) +``` + +## 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..f69131c --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,74 @@ +# 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 +```kotlin +// If you added/updated code examples, include them here + private val fastPixSDK = FastPixDataSDK() + val config = SDKConfiguration( + workspaceId = "your-workspace-id", + beaconUrl = "custom.beacon.url", // Optional + // Optional + videoData = VideoDataDetails( + videoId = "video-123", + videoTitle = "My Awesome Video", + videoDuration = "300000", // in milliseconds + videoThumbnail = "https://example.com/thumbnail.jpg", + fpPlaybackId = "playback-id" // Optional FastPix playback ID + //.. etc + ), + // Optional + playerData = PlayerDataDetails( + playerName = "ExoPlayer", + playerVersion = "2.19.0" + ), + playerListener = MyPlayerListener(), + enableLogging = true, // Enable for debugging + // Optional + customData = CustomDataDetails( + customField1 = "custom-value-1", + customField2 = "custom-value-2" + //.. etc + ) + ) + + // Initialize SDK + fastPixSDK.initialize(config, applicationContext) +``` + +### 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!** From 386c04144ee1571d9b55cd18ed226662ee185cec Mon Sep 17 00:00:00 2001 From: Siddharth Date: Mon, 17 Nov 2025 17:18:58 +0530 Subject: [PATCH 2/3] update issue templates --- .github/ISSUE_TEMPLATE/documentation_issue.md | 141 ++++++++++++++++++ 1 file changed, 141 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/documentation_issue.md b/.github/ISSUE_TEMPLATE/documentation_issue.md index e69de29..6d31c43 100644 --- a/.github/ISSUE_TEMPLATE/documentation_issue.md +++ b/.github/ISSUE_TEMPLATE/documentation_issue.md @@ -0,0 +1,141 @@ +--- +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?** + +```markdown + +# Correct Documentation + +Here's how the documentation should be written: + +```kotlin +// Correct code example + private val fastPixSDK = FastPixDataSDK() + + // Create configuration + val config = SDKConfiguration( + workspaceId = "your-workspace-id", + beaconUrl = "custom.beacon.url", // Optional + // Optional + videoData = VideoDataDetails( + videoId = "video-123", + videoTitle = "My Awesome Video", + videoDuration = "300000", // in milliseconds + videoThumbnail = "https://example.com/thumbnail.jpg", + fpPlaybackId = "playback-id" // Optional FastPix playback ID + //.. etc + ), + // Optional + playerData = PlayerDataDetails( + playerName = "ExoPlayer", + playerVersion = "2.19.0" + ), + playerListener = MyPlayerListener(), + enableLogging = true, // Enable for debugging + // Optional + customData = CustomDataDetails( + customField1 = "custom-value-1", + customField2 = "custom-value-2" + //.. etc + ) + ) + + // Initialize SDK + fastPixSDK.initialize(config, applicationContext) +``` + +## 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 From 3620c7fde04d5744410ac8c9a1344f530540b249 Mon Sep 17 00:00:00 2001 From: Siddharth Date: Wed, 19 Nov 2025 16:53:15 +0530 Subject: [PATCH 3/3] update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 63 +++++++++++++++++++++++----- 1 file changed, 53 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 434eb7b..ac23844 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -9,19 +9,62 @@ assignees: '' ## Bug Description A clear and concise description of what the bug is. -## Steps to Reproduce -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +## Reproduction Steps -## Expected Behavior -A clear and concise description of what you expected to happen. +1. **Setup Environment** -## Actual Behavior -A clear and concise description of what actually happened. +```groovy +dependencies { + implementation 'io.fastpix.data:media3:1.2.2' +} +``` + +2. **Code To Reproduce** + +```kotlin + val config = SDKConfiguration( + workspaceId = "your-workspace-id", + beaconUrl = "custom.beacon.url", // Optional + // Optional + videoData = VideoDataDetails( + videoId = "video-123", + videoTitle = "My Awesome Video", + videoDuration = "300000", // in milliseconds + videoThumbnail = "https://example.com/thumbnail.jpg", + fpPlaybackId = "playback-id" // Optional FastPix playback ID + //.. etc + ), + // Optional + playerData = PlayerDataDetails( + playerName = "ExoPlayer", + playerVersion = "2.19.0" + ), + playerListener = MyPlayerListener(), + enableLogging = true, // Enable for debugging + // Optional + customData = CustomDataDetails( + customField1 = "custom-value-1", + customField2 = "custom-value-2" + //.. etc + ) +) + +// Initialize SDK +fastPixSDK.initialize(config, applicationContext) +``` + +3. **Expected Behavior** +``` + +``` + +4. **Actual Behavior** +``` + +``` + +5. **Environment** -## Environment - **SDK Version**: [e.g., 1.2.2] - **Android Version**: [e.g., Android 12] - **Min SDK Version**: [e.g., 24]