Skip to content

Latest commit

 

History

History
166 lines (128 loc) · 4.41 KB

CONTRIBUTING.md

File metadata and controls

166 lines (128 loc) · 4.41 KB

Contributing to RealSense University

Thank you for your interest in contributing to RealSense University! This document provides guidelines and information for contributors.

🤝 How to Contribute

🐛 Reporting Issues

  • Use the GitHub Issues page
  • Search existing issues before creating new ones
  • Provide detailed information about the problem
  • Include system information and error messages

💡 Suggesting Enhancements

  • Use the GitHub Discussions page
  • Clearly describe the enhancement
  • Explain why it would be beneficial
  • Provide examples if possible

🔧 Code Contributions

  • Fork the repository
  • Create a feature branch
  • Make your changes
  • Add tests and documentation
  • Submit a pull request

📋 Contribution Guidelines

🎯 Code Style

  • Follow PEP 8 for Python code
  • Use Black for code formatting
  • Write clear, descriptive variable names
  • Add docstrings to functions and classes
  • Include type hints where appropriate

📝 Documentation

  • Update README files when adding new features
  • Include code examples in docstrings
  • Update the curriculum when adding new modules
  • Write clear commit messages

🧪 Testing

  • Write unit tests for new functionality
  • Test on multiple platforms when possible
  • Ensure all tests pass before submitting
  • Add integration tests for complex features

🔍 Code Review Process

  • All submissions require review
  • Address feedback promptly
  • Be respectful and constructive
  • Help others improve their contributions

🏗️ Development Setup

📦 Prerequisites

  • Python 3.7+
  • Git
  • RealSense SDK 2.0
  • Required Python packages (see requirements.txt)

🚀 Setup Instructions

# Fork and clone the repository
git clone https://github.com/your-username/realsense-university.git
cd realsense-university

# Install dependencies
pip install -r requirements.txt

# Install development dependencies
pip install -r requirements-dev.txt

# Set up pre-commit hooks
pre-commit install

🧪 Running Tests

# Run all tests
pytest

# Run specific test files
pytest tests/test_level_1.py

# Run with coverage
pytest --cov=realsense_university

📚 Content Guidelines

🎓 Educational Content

  • Write clear, beginner-friendly explanations
  • Include hands-on exercises
  • Provide real-world examples
  • Use consistent terminology

💻 Code Examples

  • Write well-commented code
  • Include error handling
  • Provide usage examples
  • Test all code examples

🎥 Video Content

  • Keep videos focused and concise
  • Include clear audio and visuals
  • Provide transcripts for accessibility
  • Use consistent branding

🏆 Recognition

🌟 Contributors

  • All contributors are listed in CONTRIBUTORS.md
  • Significant contributors receive special recognition
  • Community contributors are featured in highlights

🎖️ Badges

  • Contributor: First contribution
  • Reviewer: Code review contributions
  • Mentor: Help other contributors
  • Expert: Significant technical contributions

📞 Getting Help

🆘 Support Channels

👥 Community

📄 License

By contributing to RealSense University, you agree that your contributions will be licensed under the MIT License.

🎯 Areas for Contribution

📚 Content

  • New modules and tutorials
  • Code examples and templates
  • Video content and demonstrations
  • Documentation improvements

🔧 Technical

  • Bug fixes and improvements
  • New features and functionality
  • Performance optimizations
  • Cross-platform compatibility

🎨 Design

  • UI/UX improvements
  • Visual design and branding
  • Website and documentation design
  • Video and presentation materials

🌍 Community

  • Help other contributors
  • Moderate discussions
  • Organize events and workshops
  • Translate content to other languages

Ready to contribute? Start by joining our Discord community or GitHub discussions!