| # Contributing to OpenPRoT |
| |
| ## Contributor License Agreement |
| |
| - Use of OpenPRoT requires no CLA. |
| - Contributions to OpenPRoT must have signed the [CHIPS CLA](https://github.com/chipsalliance/Caliptra/blob/main/CONTRIBUTING.md#contributor-license-agreement). |
| |
| ## Code of Conduct |
| |
| The code of conduct can be found [here](https://github.com/OpenPRoT/.github/blob/main/CODE_OF_CONDUCT.md). |
| |
| ## Development Setup |
| |
| 1. Clone the repository |
| 2. Install dependencies: `cargo xtask check` |
| 3. Run tests: `cargo xtask test` |
| 4. Format code: `cargo xtask fmt` |
| |
| ## Code Style |
| |
| - Use `cargo xtask fmt` to format code |
| - Run `cargo xtask clippy` to 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 |
| |
| 1. Fork the repository |
| 2. Create a feature branch |
| 3. Make your changes |
| 4. Run the full test suite |
| 5. Submit a pull request |
| |
| ## Issues |
| |
| Please report issues on the GitHub issue tracker. |
