spacecruft
/
nopenpilot
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Added section for "How can I begin contributing?"

master
Michael Honan 2021-01-27 16:13:58 +11:00
parent 2614ce5404
commit e722ea3cf7
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
FAQ.md

@ -29,6 +29,7 @@ Table of Contents
* [Development](#development)
* [What is the openpilot development workflow? / What are the branches master, devel, and release?](#what-is-the-openpilot-development-workflow--what-are-the-branches-master-devel-and-release)
* [What do the LED colors mean?](#what-do-the-led-colors-mean)
* [How can I begin contributing?](#how-can-i-begin-contributing)
* [Discord Help](#discord-help)
* [Before Asking a Question](#before-asking-a-question)
* [How do I search on discord?](#how-do-i-search-on-discord)
@ -135,6 +136,21 @@ Step by step guide for accessing video files [here](../wiki/Video-Files).
* Blue (fades in and out): power saving
```
### How can I begin contributing?
To contribute to openpilot's codebase:
* Know Python / C++ (depends on which part of OP you want to contribute to)
* Learn Git and Github Pull Requests
* Read comma's blog posts related to development: https://medium.com/@comma_ai
* Read the openpilot `CONTRIBUTING.md` file: https://github.com/commaai/openpilot/blob/master/CONTRIBUTING.md
* Look at the issues page on Github (Particularly the "good first issue" label: https://github.com/commaai/openpilot/labels/good%20first%20issue)
* Read through the code and understand the architecture
* Search Discord with any questions you think of before asking (as per #guidelines )
If you're not into coding, feel free to join the comma pencil movement! You can help comma train their driving model by annotating driving data.
Join the [Discord](https://discord.comma.ai) and check out the pinned messages in the `#comma-pencil` channel!
# Discord Help
comma.ai is a very open company. Their developers spend a lot of time on the Discord Server working with users and collaborating with other community developers. This is awesome. <u>But please don't abuse this.</u> Asking questions that have already be answered is a waste of everyone's time. Wasting developer time, means slower improvements for us all.