Documentation
Contributing
Guidelines for contributing to MudPi through pull requests, documentation, and examples.
Welcome
MudPi is primarily maintained by a solo developer with a full-time job and a family. I work on MudPi when I can, and I appreciate every contribution — whether it's code, documentation, bug reports, or ideas. Dad priorities come first, but I'll review your contributions as soon as I'm able.
Submitting New Features
To submit a new feature or extension:
- Read through the relevant documentation first, especially Extensions and Extending MudPi
- Fork the repository and create a feature branch
- Submit a pull request using the PR template
- Include a clear description of what your feature does and why it's useful
Testing Description Requirements
Every PR should include a testing description with the following details:
| Field | Description |
|---|---|
| Python Version | The Python version used for testing (e.g., 3.9, 3.11) |
| Hardware | Board and sensors used (e.g., Raspberry Pi 4, DHT22) |
| OS | Operating system (e.g., Raspbian Bullseye, Ubuntu 22.04) |
| Components | MudPi components affected by the change |
| Configurations | Relevant configuration snippets used during testing |
Documentation Contributions
Documentation improvements are always welcome. When contributing docs:
- Use markdown format
- Include code examples where applicable
- Keep language clear and concise
- Follow the existing documentation structure and tone
Examples
Real-world examples help new users get started quickly. If you've built something interesting with MudPi, consider sharing your configuration, wiring diagrams, or project write-ups. Examples can be submitted as pull requests to the documentation repository.
Submitting Bug Fixes
Found a bug? Here's how to help:
- Check the Troubleshooting page to see if it's a known issue
- Open an issue on GitHub with steps to reproduce the bug
- If you have a fix, submit a PR that references the issue
- Include the testing description (see above) so we can verify the fix
Tip
Even small contributions matter — fixing a typo, clarifying a confusing paragraph, or adding a missing config example all help improve MudPi for the community.