Skip to content

Commit cf84fc7

Browse files
alokemajumderalokemajumder
committed
Fix : Phase 1
1 parent 4abb701 commit cf84fc7

33 files changed

+7329
-627
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
title: '[BUG] '
5+
labels: ['bug', 'needs-triage']
6+
assignees: ''
7+
---
8+
9+
## 🐛 Bug Description
10+
A clear and concise description of what the bug is.
11+
12+
## 🔄 Steps to Reproduce
13+
Steps to reproduce the behavior:
14+
15+
1. Go to '...'
16+
2. Click on '...'
17+
3. Scroll down to '...'
18+
4. See error
19+
20+
## ✅ Expected Behavior
21+
A clear and concise description of what you expected to happen.
22+
23+
## ❌ Actual Behavior
24+
A clear and concise description of what actually happened.
25+
26+
## 📸 Screenshots
27+
If applicable, add screenshots to help explain your problem.
28+
29+
## 🌍 Environment
30+
**Docker Environment:**
31+
- Docker Version: [e.g., 24.0.6]
32+
- Docker Compose Version: [e.g., v2.20.0]
33+
- Host OS: [e.g., Ubuntu 22.04, macOS 13.0, Windows 11]
34+
35+
**Local Development (if applicable):**
36+
- OS: [e.g., Ubuntu 22.04]
37+
- Go Version: [e.g., 1.23]
38+
- FFmpeg Version: [e.g., 6.1]
39+
- PostgreSQL Version: [e.g., 16]
40+
- Redis Version: [e.g., 7]
41+
42+
**API Details:**
43+
- API Version: [e.g., 2.0.0]
44+
- Authentication Method: [e.g., API Key, JWT]
45+
- Endpoint: [e.g., POST /api/v1/probe/file]
46+
47+
## 📋 Configuration
48+
**Environment Variables (remove sensitive data):**
49+
```bash
50+
STORAGE_PROVIDER=s3
51+
ENABLE_AUTH=true
52+
# Add relevant config here
53+
```
54+
55+
**Request Details (if API related):**
56+
```bash
57+
curl -X POST "http://localhost:8080/api/v1/probe/file" \
58+
-H "X-API-Key: ***" \
59+
-H "Content-Type: application/json" \
60+
-d '{
61+
"file_path": "/path/to/video.mp4"
62+
}'
63+
```
64+
65+
## 📝 Logs
66+
**Error Logs:**
67+
```
68+
Paste any relevant log output here (remove sensitive information)
69+
```
70+
71+
**Docker Logs (if applicable):**
72+
```bash
73+
# Command used to get logs
74+
docker compose logs ffprobe-api
75+
76+
# Log output
77+
[paste logs here]
78+
```
79+
80+
## 🔍 Additional Context
81+
Add any other context about the problem here.
82+
83+
**Media File Details (if relevant):**
84+
- File format: [e.g., MP4, MOV]
85+
- File size: [e.g., 1.2GB]
86+
- Video codec: [e.g., H.264]
87+
- Resolution: [e.g., 1920x1080]
88+
- Duration: [e.g., 2 minutes 30 seconds]
89+
90+
**Error Frequency:**
91+
- [ ] This happens every time
92+
- [ ] This happens occasionally
93+
- [ ] This happened only once
94+
95+
**Impact:**
96+
- [ ] Blocks functionality completely
97+
- [ ] Degrades performance
98+
- [ ] Minor inconvenience
99+
100+
## 🔧 Attempted Solutions
101+
What have you tried to resolve this issue?
102+
103+
- [ ] Restarted Docker containers
104+
- [ ] Checked Docker logs
105+
- [ ] Verified environment variables
106+
- [ ] Tested with different files
107+
- [ ] Checked API documentation
108+
- [ ] Searched existing issues
109+
110+
## 🆘 Priority
111+
- [ ] Low - Nice to have fix
112+
- [ ] Medium - Affects some workflows
113+
- [ ] High - Blocks important functionality
114+
- [ ] Critical - Production system down
115+
116+
---
117+
118+
**Note:** Please ensure you've checked the [FAQ](../docs/FAQ.md) and [existing issues](https://github.com/your-org/ffprobe-api/issues) before submitting.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 185 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,185 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] '
5+
labels: ['enhancement', 'needs-discussion']
6+
assignees: ''
7+
---
8+
9+
## 💡 Feature Description
10+
A clear and concise description of the feature you'd like to see implemented.
11+
12+
## 🎯 Problem Statement
13+
**What problem does this solve?**
14+
Describe the problem or limitation you're experiencing that this feature would address.
15+
16+
**Who would benefit from this feature?**
17+
- [ ] Individual developers
18+
- [ ] Small teams
19+
- [ ] Enterprise users
20+
- [ ] API integrators
21+
- [ ] Content creators
22+
- [ ] Video streaming platforms
23+
- [ ] Other: ___________
24+
25+
## 🚀 Proposed Solution
26+
**How do you envision this feature working?**
27+
Describe your ideal solution in detail.
28+
29+
**API Endpoint Design (if applicable):**
30+
```bash
31+
# Example API call
32+
curl -X POST "http://localhost:8080/api/v1/new-feature" \
33+
-H "X-API-Key: your-api-key" \
34+
-H "Content-Type: application/json" \
35+
-d '{
36+
"parameter": "value"
37+
}'
38+
```
39+
40+
**Expected Response:**
41+
```json
42+
{
43+
"status": "success",
44+
"data": {
45+
"feature_result": "example"
46+
}
47+
}
48+
```
49+
50+
## 🔄 Alternatives Considered
51+
**What other approaches have you considered?**
52+
Describe alternative solutions or features you've considered.
53+
54+
**Existing Workarounds:**
55+
How are you currently handling this use case, if at all?
56+
57+
## 📋 Implementation Notes
58+
**Technical Considerations:**
59+
- [ ] Requires FFmpeg updates
60+
- [ ] Needs database schema changes
61+
- [ ] Impacts existing APIs
62+
- [ ] Requires new dependencies
63+
- [ ] Performance implications
64+
- [ ] Security considerations
65+
66+
**Dependencies:**
67+
List any external libraries, services, or tools this feature would require.
68+
69+
**Breaking Changes:**
70+
- [ ] This is a breaking change
71+
- [ ] This is backward compatible
72+
- [ ] Unsure about compatibility impact
73+
74+
## 🎨 User Experience
75+
**How should users interact with this feature?**
76+
77+
**Configuration Requirements:**
78+
```bash
79+
# New environment variables (if any)
80+
NEW_FEATURE_ENABLED=true
81+
NEW_FEATURE_CONFIG=value
82+
```
83+
84+
**Documentation Needs:**
85+
- [ ] API documentation updates
86+
- [ ] Tutorial/guide needed
87+
- [ ] Configuration examples
88+
- [ ] Migration guide (if breaking)
89+
90+
## 📊 Use Cases
91+
**Primary Use Case:**
92+
Describe the main scenario where this feature would be used.
93+
94+
**Additional Use Cases:**
95+
1. Use case 1
96+
2. Use case 2
97+
3. Use case 3
98+
99+
**Example Scenarios:**
100+
```bash
101+
# Scenario 1: Basic usage
102+
curl -X POST "/api/v1/example" -d '{"basic": "usage"}'
103+
104+
# Scenario 2: Advanced usage
105+
curl -X POST "/api/v1/example" -d '{"advanced": "options"}'
106+
```
107+
108+
## 🔗 Related Features
109+
**Existing Features:**
110+
Which existing features would this complement or interact with?
111+
112+
**Future Features:**
113+
How might this feature enable or connect to future enhancements?
114+
115+
## 📈 Success Metrics
116+
**How would we measure the success of this feature?**
117+
- [ ] Usage metrics
118+
- [ ] Performance improvements
119+
- [ ] User feedback
120+
- [ ] Reduced support requests
121+
- [ ] Other: ___________
122+
123+
## 🎯 Priority
124+
**Business Impact:**
125+
- [ ] Low - Nice to have
126+
- [ ] Medium - Would improve workflows
127+
- [ ] High - Significantly enhances capabilities
128+
- [ ] Critical - Essential for major use cases
129+
130+
**Implementation Complexity:**
131+
- [ ] Low - Simple addition
132+
- [ ] Medium - Moderate development effort
133+
- [ ] High - Complex implementation
134+
- [ ] Very High - Major architectural changes
135+
136+
## 📱 Target Audience
137+
**Who is the primary target for this feature?**
138+
- [ ] API developers
139+
- [ ] Content creators
140+
- [ ] Video engineers
141+
- [ ] DevOps teams
142+
- [ ] QA/Testing teams
143+
- [ ] Enterprise customers
144+
145+
**Technical Expertise Level:**
146+
- [ ] Beginner-friendly
147+
- [ ] Intermediate users
148+
- [ ] Advanced/technical users
149+
- [ ] Expert-level feature
150+
151+
## 🔍 Additional Context
152+
**Industry Standards:**
153+
Does this feature align with or implement any industry standards?
154+
155+
**Competitive Analysis:**
156+
How do other similar tools handle this use case?
157+
158+
**References:**
159+
Link to any relevant documentation, standards, or examples:
160+
- [Link 1](example.com)
161+
- [Link 2](example.com)
162+
163+
**Mockups/Diagrams:**
164+
If you have any visual representations of the feature, please attach them.
165+
166+
## 🤝 Contribution
167+
**Are you willing to contribute to this feature?**
168+
- [ ] Yes, I can help with implementation
169+
- [ ] Yes, I can help with testing
170+
- [ ] Yes, I can help with documentation
171+
- [ ] I can provide feedback/review
172+
- [ ] I'm just suggesting the idea
173+
174+
**Technical Skills:**
175+
If you're willing to contribute, what are your technical skills?
176+
- [ ] Go programming
177+
- [ ] Frontend development
178+
- [ ] API design
179+
- [ ] Documentation writing
180+
- [ ] Testing/QA
181+
- [ ] DevOps/Docker
182+
183+
---
184+
185+
**Note:** Feature requests are evaluated based on alignment with project goals, technical feasibility, and community interest. Please check our [roadmap](https://github.com/your-org/ffprobe-api/projects) for planned features.

0 commit comments

Comments
 (0)