Contributing to OpenTitan
Thank you for your interest in contributing to OpenTitan. This document provides some guidelines to making those contributions. Important points before getting started:
- We consider honest feedback crucial to quality. We work hard to thoroughly review changes and provide actionable feedback. We do this to ensure a high quality open source design.
- Always assume good intent. Our feedback may be demanding and may even feel disheartening. Again, this is to support a high quality silicon design, and we definitely appreciate all OpenTitan contributions.
- Please be friendly and patient in your communications.
- All OpenTitan interactions are covered by lowRISC’s code of conduct.
- When communicating, remember OpenTitan is a security-focused project. Because of this, certain issues may need to be discussed in a small group first. See the Security Issues Process described below for more details.
- OpenTitan involves both hardware and software. We follow a hybrid approach involving both silicon and software design practices.
- OpenTitan is a work in progress. We are always looking for ways to improve and welcome feedback on any project matter, technical or not.
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.
To report a security issue, please follow the Security Issues Process.
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 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,
- to ensure responsible disclosure of vulnerabilities,
- or to discuss the security impact of new features or proposed changes to an existing feature.
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 email@example.com 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:
- Discuss the matter with the team, either through the firstname.lastname@example.org mailing list or through discussions in issues on GitHub. Agree on a course of action and document this in a GitHub issue.
- Implement the contribution, i.e., the solution previously agreed on, and reference the discussion when submitting the contribution.
- Have the implementation reviewed by the team, address any feedback, and finally have it integrated into the project.
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.