The ot-provisioning project follows the contribution guidelines of the OpenTitan project. The following sections contain references to important documents as well as some tips on how to adopt best practices.
The following guides provide detailed guides on how to contribute to the project:
- lowRISC Code of Conduct
- OpenTitan Lightweight Contribution Guide
- OpenTitan In-depth Contribution Guide
- GitHub Notes | OpenTitan Documentation: Instructions on how to fork and configure the repository and manage pull requests from a git perspective.
Style guides are enforced to ensure the repository meets uniform style conventions. Code reviewers are responsible for enforcing these guidelines.
- C and C++ Coding Style Guide | OpenTitan Documentation
- Google C++ Style Guide
- Go Style Guide
- Shell Style Guide
The repository provides the following formatting utilities to automate the application of some style guidelines:
# Format C++ code
bazelisk run clang_format
# Format Golang code
bazelisk run gofmtThe following documents provide guidelines for commit authors and reviewers. References to these best practices are used during code reviews to capture the rationale behind the process.