Thank you for your interest in contributing to EmbeddedController!
This project is focused on learning, clarity, and clean embedded systems design.
- Be respectful and constructive
- Keep contributions focused and well-documented
- Prioritize readability and learning value
- Fork the repository
- Create a new branch from
main - Use a clear branch name (e.g.
gpio-driver,uart-fix)
- Follow existing code style and structure
- Add comments for hardware-specific or low-level logic
- Ensure the project builds successfully using PlatformIO
- Write clear commit messages
- One logical change per commit when possible
- Describe what the change does and why it’s needed
- Reference related issues if applicable
- Avoid large refactors without prior discussion
- Bug fixes
- Peripheral drivers and experiments
- Documentation improvements
- Learning-focused enhancements
- Unclear or undocumented code
- Breaking changes without explanation
- Unrelated changes in a single PR
- Build must pass (
pio run) - Upload and runtime testing is encouraged when applicable
This project values:
- Learning over perfection
- Simplicity over cleverness
- Correctness over speed
By contributing, you agree that your work will be shared for educational and open-source purposes.