Skip to content

Home

Jump to bottom
Michael Beyeler edited this page Mar 5, 2017 · 2 revisions

Welcome to the CARLsim3 wiki!

Contributing

If you wish to contribute to CARLsim3, please check out our CONTRIBUTING.md. This file has detailed information on how to get the code and how to create a pull request.

In short:

  • We use the GitHub Issue Tracker as a to do list.
  • Before you start coding, make sure nobody else is already working on an issue.
  • Fork and clone the repo, then work on your own branch.
  • Follow the coding guidelines.
  • Make sure to add documentation and to make all tests pass before you submit a pull request (PR).
  • Mark your PR as work in progress by prefixing your PR title with [WIP]. PRs that are ready to be merged should be prefixed with [MRG]. You can request reviews from anyone in the core team.
Clone this wiki locally