Contributing
Thank you for your interest in improving this course! Contributions are welcome and appreciated.
How to Contribute
Reporting Issues
Found an error or have a suggestion?
- Check existing issues
- Create a new issue with:
- Clear description
- Module and section reference
- Expected vs actual behavior
- Suggested fix (if applicable)
Suggesting Improvements
Have ideas for new content or improvements?
- Open a discussion
- Describe your suggestion
- Explain the value it would add
Contributing Content
Want to contribute code, examples, or content?
Process:
- Fork the repository
- Create a feature branch:
git checkout -b feature/your-feature - Make your changes
- Test locally:
mdbook serve - Commit:
git commit -m "Add: your feature" - Push:
git push origin feature/your-feature - Open a Pull Request
Guidelines:
- Follow existing code style
- Include working code examples
- Add comments and explanations
- Test all code before submitting
- Keep examples concise but complete
Content Guidelines
Code Examples
- Use Python 3.9+ syntax
- Include type hints
- Add docstrings
- Handle errors gracefully
- Keep examples under 100 lines when possible
Writing Style
- Clear and concise
- Explain “why” not just “how”
- Use active voice
- Include practical examples
- Link to related sections
Structure
- Start with learning objectives
- Provide context before code
- Explain code after showing it
- End with key takeaways
- Link to next steps
Types of Contributions
High Priority
- Fixing errors or bugs in code
- Improving unclear explanations
- Adding missing error handling
- Updating deprecated APIs
Medium Priority
- Adding practice exercises
- Creating additional examples
- Improving diagrams
- Expanding explanations
Nice to Have
- Translations
- Video tutorials
- Interactive demos
- Community showcases
Code of Conduct
- Be respectful and constructive
- Welcome newcomers
- Focus on improving the content
- Give credit where due
- Assume good intentions
Recognition
Contributors will be acknowledged in:
- GitHub contributors list
- Course acknowledgments section
- Release notes
Questions?
Open a discussion or reach out via GitHub issues.
Thank you for helping make this course better! 🙏