Enhance README.md with badges, installation instructions, and community support details. Improved project structure and added quick contribution guidelines.
This commit is contained in:
defiQUG
254
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
254
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@@ -0,0 +1,254 @@
|
||||
---
|
||||
name: Feature Request
|
||||
about: Suggest an idea for NowYouSeeMe
|
||||
title: '[FEATURE] '
|
||||
labels: ['enhancement', 'needs-triage']
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## 🚀 Feature Description
|
||||
|
||||
A clear and concise description of the feature you'd like to see implemented.
|
||||
|
||||
## 🎯 Use Case
|
||||
|
||||
Describe how this feature would be used and what problem it solves:
|
||||
|
||||
- **Problem**: What problem does this feature solve?
|
||||
- **Solution**: How does this feature address the problem?
|
||||
- **Users**: Who would benefit from this feature?
|
||||
- **Impact**: What would be the impact of implementing this feature?
|
||||
|
||||
## 💡 Proposed Implementation
|
||||
|
||||
If you have ideas on how this could be implemented, please describe them:
|
||||
|
||||
### Technical Approach
|
||||
```python
|
||||
# Example implementation approach
|
||||
class NewFeature:
|
||||
def __init__(self, config: FeatureConfig):
|
||||
self.config = config
|
||||
|
||||
def process_data(self, data: InputData) -> OutputData:
|
||||
# Implementation details
|
||||
pass
|
||||
```
|
||||
|
||||
### API Design
|
||||
```python
|
||||
# Example API usage
|
||||
from src.new_module import NewFeature
|
||||
|
||||
feature = NewFeature(config)
|
||||
result = feature.process_data(input_data)
|
||||
```
|
||||
|
||||
### Configuration
|
||||
```json
|
||||
{
|
||||
"new_feature": {
|
||||
"enabled": true,
|
||||
"parameter1": "value1",
|
||||
"parameter2": "value2"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 🔄 Alternatives Considered
|
||||
|
||||
What other solutions have you considered? Please include:
|
||||
|
||||
- **Alternative 1**: Description and why it wasn't chosen
|
||||
- **Alternative 2**: Description and why it wasn't chosen
|
||||
- **No implementation**: What happens if this feature isn't implemented
|
||||
|
||||
## 📊 Priority Assessment
|
||||
|
||||
### Impact
|
||||
- **User Impact**: [High/Medium/Low] - How many users would benefit?
|
||||
- **Technical Impact**: [High/Medium/Low] - How complex is the implementation?
|
||||
- **Performance Impact**: [High/Medium/Low] - How does it affect system performance?
|
||||
|
||||
### Effort Estimation
|
||||
- **Development Time**: [1-2 weeks, 1-2 months, 3+ months]
|
||||
- **Testing Effort**: [Low/Medium/High]
|
||||
- **Documentation Effort**: [Low/Medium/High]
|
||||
|
||||
## 🎯 Success Criteria
|
||||
|
||||
Define what success looks like for this feature:
|
||||
|
||||
- [ ] **Functional Requirements**
|
||||
- [ ] Feature works as described
|
||||
- [ ] Integrates with existing system
|
||||
- [ ] Maintains performance targets
|
||||
|
||||
- [ ] **Non-Functional Requirements**
|
||||
- [ ] Latency remains <20ms
|
||||
- [ ] Accuracy remains <10cm
|
||||
- [ ] Frame rate remains 30-60 FPS
|
||||
|
||||
- [ ] **User Experience**
|
||||
- [ ] Intuitive user interface
|
||||
- [ ] Clear documentation
|
||||
- [ ] Backward compatibility
|
||||
|
||||
## 🔧 Technical Requirements
|
||||
|
||||
### Hardware Requirements
|
||||
- **GPU**: [Required/Optional/Not needed]
|
||||
- **Camera**: [Required/Optional/Not needed]
|
||||
- **WiFi**: [Required/Optional/Not needed]
|
||||
- **Additional Hardware**: [List any additional requirements]
|
||||
|
||||
### Software Requirements
|
||||
- **Dependencies**: [List any new dependencies]
|
||||
- **Platform Support**: [Windows/Linux/macOS/All]
|
||||
- **Python Version**: [3.8+/3.9+/3.10+/All]
|
||||
|
||||
### Integration Points
|
||||
- **Camera Module**: [Yes/No] - Integration with camera capture
|
||||
- **RF Module**: [Yes/No] - Integration with WiFi CSI
|
||||
- **SLAM Processing**: [Yes/No] - Integration with SLAM algorithms
|
||||
- **Rendering Engine**: [Yes/No] - Integration with 3D rendering
|
||||
- **Azure Integration**: [Yes/No] - Integration with cloud services
|
||||
|
||||
## 📋 Implementation Plan
|
||||
|
||||
### Phase 1: Core Implementation
|
||||
- [ ] Design API interface
|
||||
- [ ] Implement core functionality
|
||||
- [ ] Add unit tests
|
||||
- [ ] Basic integration
|
||||
|
||||
### Phase 2: Integration
|
||||
- [ ] Integrate with existing modules
|
||||
- [ ] Add configuration options
|
||||
- [ ] Performance optimization
|
||||
- [ ] Integration tests
|
||||
|
||||
### Phase 3: Polish
|
||||
- [ ] User interface updates
|
||||
- [ ] Documentation
|
||||
- [ ] Performance testing
|
||||
- [ ] User acceptance testing
|
||||
|
||||
## 🧪 Testing Strategy
|
||||
|
||||
### Unit Tests
|
||||
```python
|
||||
class TestNewFeature:
|
||||
def test_basic_functionality(self):
|
||||
"""Test basic feature functionality"""
|
||||
feature = NewFeature(config)
|
||||
result = feature.process_data(test_data)
|
||||
assert result is not None
|
||||
|
||||
def test_performance_requirements(self):
|
||||
"""Test performance meets requirements"""
|
||||
# Performance test implementation
|
||||
```
|
||||
|
||||
### Integration Tests
|
||||
```python
|
||||
class TestNewFeatureIntegration:
|
||||
def test_integration_with_existing_modules(self):
|
||||
"""Test integration with existing system"""
|
||||
# Integration test implementation
|
||||
```
|
||||
|
||||
### Performance Tests
|
||||
```python
|
||||
class TestNewFeaturePerformance:
|
||||
def test_latency_requirements(self):
|
||||
"""Test latency remains under 20ms"""
|
||||
# Latency test implementation
|
||||
```
|
||||
|
||||
## 📚 Documentation Requirements
|
||||
|
||||
### User Documentation
|
||||
- [ ] Feature overview and benefits
|
||||
- [ ] Installation and setup instructions
|
||||
- [ ] Configuration options
|
||||
- [ ] Usage examples
|
||||
- [ ] Troubleshooting guide
|
||||
|
||||
### Developer Documentation
|
||||
- [ ] API reference
|
||||
- [ ] Architecture integration
|
||||
- [ ] Development guidelines
|
||||
- [ ] Testing procedures
|
||||
|
||||
## 🔄 Migration Strategy
|
||||
|
||||
### Backward Compatibility
|
||||
- [ ] Existing configurations continue to work
|
||||
- [ ] Existing APIs remain functional
|
||||
- [ ] No breaking changes to user workflows
|
||||
|
||||
### Upgrade Path
|
||||
- [ ] Automatic migration of existing data
|
||||
- [ ] Clear upgrade instructions
|
||||
- [ ] Rollback procedures if needed
|
||||
|
||||
## 📊 Metrics and Monitoring
|
||||
|
||||
### Success Metrics
|
||||
- **Adoption Rate**: Percentage of users enabling the feature
|
||||
- **Performance Impact**: Change in system latency/accuracy
|
||||
- **User Satisfaction**: Feedback and ratings
|
||||
- **Bug Reports**: Number of issues related to the feature
|
||||
|
||||
### Monitoring Points
|
||||
- [ ] Feature usage statistics
|
||||
- [ ] Performance impact monitoring
|
||||
- [ ] Error rate tracking
|
||||
- [ ] User feedback collection
|
||||
|
||||
## 💰 Resource Requirements
|
||||
|
||||
### Development Resources
|
||||
- **Developer Time**: [X weeks/months]
|
||||
- **Testing Time**: [X weeks/months]
|
||||
- **Documentation Time**: [X weeks/months]
|
||||
|
||||
### Infrastructure Resources
|
||||
- **Compute**: [CPU/GPU requirements]
|
||||
- **Storage**: [Additional storage needs]
|
||||
- **Network**: [Bandwidth requirements]
|
||||
|
||||
## 🎯 Acceptance Criteria
|
||||
|
||||
- [ ] **Functional**
|
||||
- [ ] Feature implements all described functionality
|
||||
- [ ] Integrates seamlessly with existing system
|
||||
- [ ] Maintains system performance targets
|
||||
|
||||
- [ ] **Quality**
|
||||
- [ ] Comprehensive test coverage (>80%)
|
||||
- [ ] No critical bugs or security issues
|
||||
- [ ] Performance benchmarks met
|
||||
|
||||
- [ ] **User Experience**
|
||||
- [ ] Intuitive and easy to use
|
||||
- [ ] Well-documented and supported
|
||||
- [ ] Positive user feedback
|
||||
|
||||
## 📝 Additional Context
|
||||
|
||||
Any other context, examples, or information that might be helpful:
|
||||
|
||||
- **Related Issues**: Links to related feature requests or bugs
|
||||
- **Research**: Links to relevant papers or implementations
|
||||
- **Examples**: Links to similar features in other projects
|
||||
- **Mockups**: UI/UX mockups or wireframes
|
||||
|
||||
---
|
||||
|
||||
**Before submitting:**
|
||||
- [ ] I have searched existing issues to avoid duplicates
|
||||
- [ ] I have provided comprehensive information about the feature
|
||||
- [ ] I have considered the impact on existing functionality
|
||||
- [ ] I have outlined a clear implementation plan
|
||||
Reference in New Issue
Block a user