Skip to content

Commit a3247fb

Browse files
Sravani289Sravani289
authored
Merge pull request #1 from FastPix/docs/updates-issue-template
Uploads SDK | Adds Issue Template
2 parents eb9a17b + 5975bf7 commit a3247fb

5 files changed

Lines changed: 615 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
11+
A clear and concise description of what the bug is.
12+
13+
## Reproduction Steps
14+
15+
1. **Setup Environment**
16+
17+
```groovy
18+
dependencies {
19+
implementation("io.fastpix.upload:X.X.X")
20+
}
21+
```
22+
23+
2. **Code To Reproduce**
24+
25+
```kotlin
26+
val sdk = FastPixUploadSdk.Builder(this)
27+
.setFile(file)
28+
.setSignedUrl(_signedUrl.orEmpty())
29+
.setChunkSize(16 * 1024 * 1024) // Chunk Size in Byte
30+
.setMaxRetries(3)
31+
.callback(new object : FastPixUploadCallbacks {
32+
override fun onProgressUpdate(progress: Double) {
33+
/* ... */
34+
}
35+
override fun onPauseUploading() {
36+
// Handle Pause State
37+
}
38+
override fun onResumeUploading() {
39+
// Handle Resume State
40+
}
41+
override fun onAbort() {
42+
// Handle Abort State
43+
}
44+
override fun onUploadInit() {
45+
// Handle Abort State
46+
}
47+
override fun onChunkHanlded(
48+
totalChunks: Int,
49+
fileSizeInBytes: Long,
50+
currentChunk: Int,
51+
currentChunkSizeInBytes: Long
52+
) {
53+
// Update the UI according chunk data
54+
}
55+
override fun onSuccess(timiMillis: Long) {
56+
// Time to complete the Upload Process
57+
}
58+
override fun onChunkUploadingFailed(
59+
failedChunkRetries: Int,
60+
chunkCount: Int,
61+
chunkSize: Int
62+
) {
63+
// Handle Chunk Upload Failure
64+
}
65+
override fun onError(error: String, timeMillis: Long) {
66+
// Handle error message
67+
}
68+
override fun onNetworkStateChanged(isOnline: Boolean) {
69+
// Handle Network Changes
70+
}
71+
72+
})
73+
.setRetryDelay(2000) // Retry Delay
74+
.build()
75+
// Starts the Uploading Process
76+
sdk.startUpload()
77+
```
78+
79+
3. **Expected Behavior**
80+
```
81+
<!-- A clear and concise description of what you expected to happen. -->
82+
```
83+
84+
4. **Actual Behavior**
85+
```
86+
<!-- A clear and concise description of what actually happened. -->
87+
```
88+
89+
5. **Environment**
90+
91+
- **SDK Version**: [e.g., 1.2.2]
92+
- **Android Version**: [e.g., Android 12]
93+
- **Min SDK Version**: [e.g., 24]
94+
- **Target SDK Version**: [e.g., 35]
95+
- **Device/Emulator**: [e.g., Pixel 5, Android Emulator]
96+
- **Player**: [e.g., ExoPlayer 2.19.0, VideoView, etc.]
97+
- **Kotlin Version**: [e.g., 2.0.21]
98+
99+
## Code Sample
100+
101+
```kotlin
102+
// Please provide a minimal code sample that reproduces the issue
103+
val sdk = FastPixUploadSdk.Builder(this)
104+
.setFile(file)
105+
.setSignedUrl(_signedUrl.orEmpty())
106+
.setChunkSize(16 * 1024 * 1024) // Chunk Size in Byte
107+
.setMaxRetries(3)
108+
.callback(new object : FastPixUploadCallbacks {
109+
override fun onProgressUpdate(progress: Double) {
110+
/* ... */
111+
}
112+
override fun onPauseUploading() {
113+
// Handle Pause State
114+
}
115+
override fun onResumeUploading() {
116+
// Handle Resume State
117+
}
118+
override fun onAbort() {
119+
// Handle Abort State
120+
}
121+
override fun onUploadInit() {
122+
// Handle Abort State
123+
}
124+
override fun onChunkHanlded(
125+
totalChunks: Int,
126+
fileSizeInBytes: Long,
127+
currentChunk: Int,
128+
currentChunkSizeInBytes: Long
129+
) {
130+
// Update the UI according chunk data
131+
}
132+
override fun onSuccess(timiMillis: Long) {
133+
// Time to complete the Upload Process
134+
}
135+
override fun onChunkUploadingFailed(
136+
failedChunkRetries: Int,
137+
chunkCount: Int,
138+
chunkSize: Int
139+
) {
140+
// Handle Chunk Upload Failure
141+
}
142+
override fun onError(error: String, timeMillis: Long) {
143+
// Handle error message
144+
}
145+
override fun onNetworkStateChanged(isOnline: Boolean) {
146+
// Handle Network Changes
147+
}
148+
149+
})
150+
.setRetryDelay(2000) // Retry Delay
151+
.build()
152+
// Starts the Uploading Process
153+
sdk.startUpload()
154+
```
155+
156+
## Logs/Stack Trace
157+
158+
```
159+
Paste relevant logs or stack traces here
160+
```
161+
162+
## Additional Context
163+
164+
Add any other context about the problem here.
165+
166+
## Screenshots
167+
168+
If applicable, add screenshots to help explain your problem.
169+

‎.github/ISSUE_TEMPLATE/documentation_issue.md‎

Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
---
2+
name: Documentation Issue
3+
about: Report problems with the FastPix Node SDK documentation
4+
title: '[DOCS] '
5+
labels: ['documentation', 'needs-triage']
6+
assignees: ''
7+
---
8+
9+
# Documentation Issue
10+
11+
Thank you for helping improve the FastPix Node SDK documentation! Please provide the following information:
12+
13+
## Issue Type
14+
- [ ] Missing documentation
15+
- [ ] Incorrect information
16+
- [ ] Unclear explanation
17+
- [ ] Broken links
18+
- [ ] Outdated content
19+
- [ ] Other: _______________
20+
21+
## Description
22+
**Clear description of the documentation issue:**
23+
24+
<!-- What's wrong with the documentation? -->
25+
26+
## Current Documentation
27+
**What does the current documentation say?**
28+
29+
<!-- Paste the current documentation content -->
30+
31+
## Expected Documentation
32+
**What should the documentation say instead?**
33+
34+
<!-- Describe what the correct documentation should be -->
35+
36+
## Location
37+
**Where is this documentation issue located?**
38+
39+
- [ ] README.md
40+
- [ ] docs/ directory
41+
- [ ] USAGE.md
42+
- [ ] CONTRIBUTING.md
43+
- [ ] API documentation
44+
- [ ] Code examples
45+
- [ ] Other: _______________
46+
47+
**Specific file and section:**
48+
<!-- e.g., README.md line 45, or docs/api-reference.md section "Authentication" -->
49+
50+
## Impact
51+
**How does this documentation issue affect users?**
52+
53+
- [ ] Blocks new users from getting started
54+
- [ ] Causes confusion for existing users
55+
- [ ] Leads to incorrect implementation
56+
- [ ] Creates support requests
57+
- [ ] Other: _______________
58+
59+
## Proposed Fix
60+
**How would you like this documentation issue to be resolved?**
61+
62+
<!-- Example of how the documentation should be written -->
63+
# Correct Documentation
64+
65+
Here's how the documentation should be written:
66+
67+
```kotlin
68+
val sdk = FastPixUploadSdk.Builder(this)
69+
.setFile(file)
70+
.setSignedUrl(_signedUrl.orEmpty())
71+
.setChunkSize(16 * 1024 * 1024) // Chunk Size in Byte
72+
.setMaxRetries(3)
73+
.callback(new object : FastPixUploadCallbacks {
74+
override fun onProgressUpdate(progress: Double) {
75+
/* ... */
76+
}
77+
override fun onPauseUploading() {
78+
// Handle Pause State
79+
}
80+
override fun onResumeUploading() {
81+
// Handle Resume State
82+
}
83+
override fun onAbort() {
84+
// Handle Abort State
85+
}
86+
override fun onUploadInit() {
87+
// Handle Abort State
88+
}
89+
override fun onChunkHanlded(
90+
totalChunks: Int,
91+
fileSizeInBytes: Long,
92+
currentChunk: Int,
93+
currentChunkSizeInBytes: Long
94+
) {
95+
// Update the UI according chunk data
96+
}
97+
override fun onSuccess(timiMillis: Long) {
98+
// Time to complete the Upload Process
99+
}
100+
override fun onChunkUploadingFailed(
101+
failedChunkRetries: Int,
102+
chunkCount: Int,
103+
chunkSize: Int
104+
) {
105+
// Handle Chunk Upload Failure
106+
}
107+
override fun onError(error: String, timeMillis: Long) {
108+
// Handle error message
109+
}
110+
override fun onNetworkStateChanged(isOnline: Boolean) {
111+
// Handle Network Changes
112+
}
113+
114+
})
115+
.setRetryDelay(2000) // Retry Delay
116+
.build()
117+
// Starts the Uploading Process
118+
sdk.startUpload()
119+
```
120+
121+
## Additional Context
122+
123+
## Screenshots
124+
<!-- If applicable, include screenshots of the documentation issue -->
125+
126+
### Related Issues
127+
- **GitHub Issues:** [Link to any related issues]
128+
- **User Feedback:** [Link to user complaints or confusion]
129+
130+
### Testing
131+
**How did you discover this issue?**
132+
133+
- [ ] While following the documentation
134+
- [ ] User reported confusion
135+
- [ ] Code didn't work as documented
136+
- [ ] Other: _______________
137+
138+
## Priority
139+
Please indicate the priority of this documentation issue:
140+
141+
- [ ] Critical (Blocks users from using the SDK)
142+
- [ ] High (Causes significant confusion)
143+
- [ ] Medium (Minor clarity issue)
144+
- [ ] Low (Cosmetic improvement)
145+
146+
## Checklist
147+
Before submitting, please ensure:
148+
149+
- [ ] I have identified the specific documentation issue
150+
- [ ] I have provided the current and expected content
151+
- [ ] I have explained the impact on users
152+
- [ ] I have proposed a clear fix
153+
- [ ] I have checked if this is already reported
154+
- [ ] I have provided sufficient context
155+
156+
---
157+
158+
**Thank you for helping improve the FastPix Node SDK documentation! 📚**

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Feature Description
10+
A clear and concise description of the feature you'd like to see.
11+
12+
## Problem Statement
13+
Is your feature request related to a problem? Please describe.
14+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
15+
16+
## Proposed Solution
17+
Describe the solution you'd like to see implemented.
18+
19+
## Alternatives Considered
20+
Describe any alternative solutions or features you've considered.
21+
22+
## Use Case
23+
Describe a specific use case or scenario where this feature would be helpful.
24+
25+
## Additional Context
26+
Add any other context, mockups, or examples about the feature request here.
27+

0 commit comments

Comments
 (0)