Skip to content

Commit 9a28d04

Browse files
sid-fastpixsid-fastpix
committed
Adds Issue Template
1 parent eb9a17b commit 9a28d04

5 files changed

Lines changed: 518 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
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.data:media3:1.2.2'
20+
}
21+
```
22+
23+
2. **Code To Reproduce**
24+
25+
```kotlin
26+
val videoDataDetails = VideoDataDetails(
27+
videoId = UUID.randomUUID().toString(),
28+
videoTitle = "My Video"
29+
).apply {
30+
videoSeries = "Demo Series"
31+
videoProducer = "Demo Producer"
32+
videoContentType = "VOD"
33+
// ..etc
34+
}
35+
// Optional
36+
val playerDataDetails = PlayerDataDetails(
37+
playerName = "media3",
38+
playerVersion = "latest-version"
39+
)
40+
// Optional
41+
val customDataDetails = CustomDataDetails().apply {
42+
customField1 = "Custom Value 1"
43+
customField2 = "Custom Value 2"
44+
// ..etc
45+
}
46+
47+
fastPixDataSDK = FastPixBaseMedia3Player(
48+
context = this,
49+
playerView = binding.playerView,
50+
exoPlayer = exoPlayer,
51+
workSpaceId = "workspace-key",
52+
playerDataDetails = playerDataDetails,
53+
videoDataDetails = videoDataDetails,
54+
customDataDetails = customDataDetails
55+
)
56+
```
57+
58+
3. **Expected Behavior**
59+
```
60+
<!-- A clear and concise description of what you expected to happen. -->
61+
```
62+
63+
4. **Actual Behavior**
64+
```
65+
<!-- A clear and concise description of what actually happened. -->
66+
```
67+
68+
5. **Environment**
69+
70+
- **SDK Version**: [e.g., 1.2.2]
71+
- **Android Version**: [e.g., Android 12]
72+
- **Min SDK Version**: [e.g., 24]
73+
- **Target SDK Version**: [e.g., 35]
74+
- **Device/Emulator**: [e.g., Pixel 5, Android Emulator]
75+
- **Player**: [e.g., ExoPlayer 2.19.0, VideoView, etc.]
76+
- **Kotlin Version**: [e.g., 2.0.21]
77+
78+
## Code Sample
79+
80+
```kotlin
81+
// Please provide a minimal code sample that reproduces the issue
82+
private val fastPixDataSDK = FastPixDataSDK()
83+
val videoDataDetails = VideoDataDetails(
84+
videoId = UUID.randomUUID().toString(),
85+
videoTitle = "My Video"
86+
).apply {
87+
videoSeries = "Demo Series"
88+
videoProducer = "Demo Producer"
89+
videoContentType = "VOD"
90+
// ..etc
91+
}
92+
// Optional
93+
val playerDataDetails = PlayerDataDetails(
94+
playerName = "media3",
95+
playerVersion = "latest-version"
96+
)
97+
// Optional
98+
val customDataDetails = CustomDataDetails().apply {
99+
customField1 = "Custom Value 1"
100+
customField2 = "Custom Value 2"
101+
// ..etc
102+
}
103+
104+
fastPixDataSDK = FastPixBaseMedia3Player(
105+
context = this,
106+
playerView = binding.playerView,
107+
exoPlayer = exoPlayer,
108+
workSpaceId = "workspace-key",
109+
playerDataDetails = playerDataDetails,
110+
videoDataDetails = videoDataDetails,
111+
customDataDetails = customDataDetails
112+
)
113+
```
114+
115+
## Logs/Stack Trace
116+
117+
```
118+
Paste relevant logs or stack traces here
119+
```
120+
121+
## Additional Context
122+
123+
Add any other context about the problem here.
124+
125+
## Screenshots
126+
127+
If applicable, add screenshots to help explain your problem.
128+

‎.github/ISSUE_TEMPLATE/documentation_issue.md‎

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
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+
private val fastPixDataSDK = FastPixDataSDK()
69+
val videoDataDetails = VideoDataDetails(
70+
videoId = UUID.randomUUID().toString(),
71+
videoTitle = "My Video"
72+
).apply {
73+
videoSeries = "Demo Series"
74+
videoProducer = "Demo Producer"
75+
videoContentType = "VOD"
76+
// ..etc
77+
}
78+
// Optional
79+
val playerDataDetails = PlayerDataDetails(
80+
playerName = "media3",
81+
playerVersion = "latest-version"
82+
)
83+
// Optional
84+
val customDataDetails = CustomDataDetails().apply {
85+
customField1 = "Custom Value 1"
86+
customField2 = "Custom Value 2"
87+
// ..etc
88+
}
89+
90+
fastPixDataSDK = FastPixBaseMedia3Player(
91+
context = this,
92+
playerView = binding.playerView,
93+
exoPlayer = exoPlayer,
94+
workSpaceId = "workspace-key",
95+
playerDataDetails = playerDataDetails,
96+
videoDataDetails = videoDataDetails,
97+
customDataDetails = customDataDetails
98+
)
99+
```
100+
101+
## Additional Context
102+
103+
## Screenshots
104+
<!-- If applicable, include screenshots of the documentation issue -->
105+
106+
### Related Issues
107+
- **GitHub Issues:** [Link to any related issues]
108+
- **User Feedback:** [Link to user complaints or confusion]
109+
110+
### Testing
111+
**How did you discover this issue?**
112+
113+
- [ ] While following the documentation
114+
- [ ] User reported confusion
115+
- [ ] Code didn't work as documented
116+
- [ ] Other: _______________
117+
118+
## Priority
119+
Please indicate the priority of this documentation issue:
120+
121+
- [ ] Critical (Blocks users from using the SDK)
122+
- [ ] High (Causes significant confusion)
123+
- [ ] Medium (Minor clarity issue)
124+
- [ ] Low (Cosmetic improvement)
125+
126+
## Checklist
127+
Before submitting, please ensure:
128+
129+
- [ ] I have identified the specific documentation issue
130+
- [ ] I have provided the current and expected content
131+
- [ ] I have explained the impact on users
132+
- [ ] I have proposed a clear fix
133+
- [ ] I have checked if this is already reported
134+
- [ ] I have provided sufficient context
135+
136+
---
137+
138+
**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)