Contributing to the Debug Probe Firmware
Contributions from the community are welcome! Whether you're fixing a bug, adding a new feature, or improving documentation, your help is appreciated.
Development Setup
To get started with development, you'll need to set up a build environment as described in the Building the Firmware guide. This includes having the ARM GCC toolchain and the Pico SDK installed.
Code Style
Please try to match the existing code style when submitting changes. This helps keep the codebase consistent and easy to read.
Submitting a Pull Request
- Fork the repository on GitHub.
- Create a new branch for your feature or bug fix:
git checkout -b my-new-feature. - Make your changes and commit them with clear, descriptive messages.
- Push your branch to your fork:
git push origin my-new-feature. - Open a Pull Request against the
masterbranch of theraspberrypi/debugproberepository.
Provide a clear description of the changes in your pull request. If it addresses an existing issue, please reference it.
Future Work & TODO
Based on the project's README.md, here are some areas where contributions would be particularly valuable:
- AutoBaud Selection: The PIO is a capable frequency counter, which could be used to automatically detect the target's UART baud rate.
- RTT Support: Integrating support for SEGGER's Real-Time Transfer (RTT) protocol would be a powerful feature for high-speed logging.