2.1 KiB
How to contribute
Our software is open source so you can solve your own problems without needing help from others. And if you solve a problem and are so kind, you can upstream it for the rest of the world to use.
Most open source development activity is coordinated through our GitHub Discussions and Discord. A lot of documentation is available on our medium.
Getting Started
- Join our Discord
- Make sure you have a GitHub account
- Fork our repositories on GitHub
Testing
Automated Testing
All PRs and commits are automatically checked by GitHub Actions. Check out .github/workflows/ for what GitHub Actions runs. Any new tests should be added to GitHub Actions.
Code Style and Linting
Code is automatically checked for style by GitHub Actions as part of the automated tests. You can also run these tests yourself by running pre-commit run --all.
Car Ports (openpilot)
We've released a Model Port guide for porting to Toyota/Lexus models.
If you port openpilot to a substantially new car brand, see this more generic Brand Port guide.
Pull Requests
Pull requests should be against the master branch. Before running master on in-car hardware, you'll need to clone the submodules too. That can be done by recursively cloning the repository:
git clone https://github.com/commaai/openpilot.git --recursive
Or alternatively, when on the master branch:
git submodule update --init
The reasons for having submodules on a dedicated repository and our new development philosophy can be found in our post about externalization. Modules that are in seperate repositories include:
- cereal
- laika
- opendbc
- panda
- rednose