Thank you for your interest in contributing to OpenTitan. This document provides some guidelines to making those contributions. Important points before getting started:
Important: Please read the next three, short sections on reporting bugs, reporting security issues, and contributing code in preparation for making your first contribution to OpenTitan. If you would like more details, see the [Detailed Contribution Guide]({{<relref “detailed_contribution_guide/_index.md” >}}).
To report a security issue, please follow the [Security Issues Process]({{<ref “#security-issues” >}}).
Ideally, all designs are bug free. Realistically, each piece of collateral in our repository is in a different state of maturity with some still under active testing and development. See the [Hardware Development Stages]({{< relref “development_stages” >}}) for an example of how hardware progress is tracked.
We are happy to receive bug reports and eager to fix them. Please make reports by opening a new issue in our GitHub issue tracker.
Security is of major importance to the OpenTitan project. When dealing with security matters, and in keeping with standard industry practice, there are reasons why it makes sense to be cautious and have a non-public discussion within a small group of experts before full disclosure. For example,
If you believe you have found a security issue or intend to work on potentially security sensitive matters, please first reach out to our experienced security team at security@opentitan.org before starting a public discussion. That will enable us to engage successfully without creating undue risk to the project or its consumers.
The information below aims at helping you get involved in the OpenTitan project by guiding you through our process of preparing your contribution and getting it integrated.
For straight-forward and non-invasive contributions, a high level of coordination is unlikely to be necessary. In these cases, please open a pull request.
For larger proposed changes we ask contributors to:
Note that contributions must be accompanied by sign-off text which indicates acceptance of the project's Contributor License Agreement - see CONTRIBUTING.md for details.