Contributing to OpenPRoT
Contributor License Agreement
- Use of OpenPRoT requires no CLA.
- Contributions to OpenPRoT must have signed the CHIPS CLA.
Code of Conduct
The code of conduct can be found here.
Development Setup
- Clone the repository
- Install dependencies:
cargo xtask check - Run tests:
cargo xtask test - Format code:
cargo xtask fmt
Code Style
- Use
cargo xtask fmtto format code - Run
cargo xtask clippyto check for lints - Ensure all tests pass with
cargo xtask test
Documentation
- Update documentation in the
docs/directory - Build docs with
cargo xtask docs - Documentation is built with mdbook
Pull Requests
- Fork the repository
- Create a feature branch
- Make your changes
- Run the full test suite
- Submit a pull request
Issues
Please report issues on the GitHub issue tracker.