Contributing to CARLA
We are more than happy to accept contributions!
How can I contribute?
- Reporting bugs
- Feature requests
- Improving documentation
- Code contributions
Use our issue section on GitHub. Please check before that the issue is not already reported, and make sure you have read our CARLA Documentation and FAQ.
Please check first the list of feature requests. If it is not there and you think is a feature that might be interesting for users, please submit your request as a new issue.
If you feel something is missing in the documentation, please don't hesitate to open an issue to let us know. Even better, if you think you can improve it yourself, it would be a great contribution to the community!
We build our documentation with MkDocs based on the Markdown files inside the "Docs" folder. You can either directly modify them on GitHub or locally in your machine.
Once you are done with your changes, please submit a pull-request.
TIP: You can build and serve it locally by running
mkdocs in the project's
$ sudo pip install mkdocs $ mkdocs serve
So you are considering making a code contribution, great! we love to have contributions from the community.
Before starting hands-on on coding, please check out our issue board to see if we are already working on that, it would be a pity putting an effort into something just to discover that someone else was already working on that. In case of doubt or to discuss how to proceed, please contact one of us (or send an email to firstname.lastname@example.org).
What should I know before I get started?
Check out the "CARLA Documentation" to get an idea on CARLA. In addition you may want to check the Getting started document.
Please follow the current coding standard when submitting new code.
Once you think your contribution is ready to be added to CARLA, please submit a pull-request.
Try to be as descriptive as possible when filling the pull-request description. Adding images and gifs may help people to understand your changes or new features.
Please note that there are some checks that the new code is required to pass before we can do the merge. The checks are automatically run by the continuous integration system, you will see a green tick mark if all the checks succeeded. If you see a red mark, please correct your code accordingly.
- [ ] Your branch is up-to-date with the
masterbranch and tested with latest changes
- [ ] Extended the README / documentation, if necessary
- [ ] Code compiles correctly