Skip to content

Latest commit

 

History

History
65 lines (47 loc) · 3.45 KB

CONTRIBUTING.md

File metadata and controls

65 lines (47 loc) · 3.45 KB
Raw

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. Check out our post about externalization.

Development is coordinated through Discord and GitHub.

Getting Started

What contributions are we looking for?

openpilot's priorities are safety, stability, quality, and features, in that order. openpilot is part of comma's mission to solve self-driving cars while delivering shippable intermediaries, and all development is towards that goal.

What gets merged?

The probability of a pull request being merged is a function of its value to the project and the effort it will take us to get it merged. If a PR offers some value but will take lots of time to get merged, it will be closed. Simple, well-tested bug fixes are the easiest to merge, and new features are the hardest to get merged.

All of these are examples of good PRs:

What doesn't get merged?

  • style changes: code is art, and it's up to the author to make it beautiful
  • 500+ line PRs: clean it up, break it up into smaller PRs, or both
  • PRs without a clear goal: every PR must have a singular and clear goal
  • UI design: we do not have a good review process for this yet
  • New features: We believe openpilot is mostly feature-complete, and the rest is a matter of refinement and fixing bugs. As a result of this, most feature PRs will be immediately closed, however the beauty of open source is that forks can and do offer features that upstream openpilot doesn't.
  • Negative expected value: This a class of PRs that makes an improvement, but the risk or validation costs more than the improvement. The risk can be mitigated by first getting a failing test merged.

First contribution

Bounties are the best place to get started. There's lot of bounties that don't require a comma 3/3X or a car.

Pull Requests

Pull requests should be against the master branch.

A good pull request has all of the following:

  • a clearly stated purpose
  • every line changed directly contributes to the stated purpose
  • verification, i.e. how did you test your PR?
  • justification
    • if you've optimized something, post benchmarks to prove it's better
    • if you've improved your car's tuning, post before and after plots
  • passes the CI tests

Contributing without Code

  • Report bugs in GitHub issues.
  • Report driving issues in the #driving-feedback Discord channel.
  • Consider opting into driver camera uploads to improve the driver monitoring model.
  • Connect your device to Wi-Fi regularly, so that we can pull data for training better driving models.
  • Run the nightly branch and report issues. This branch is like master but it's built just like a release.
  • Annotate images in the comma10k dataset.