Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 1.63 KB

CONTRIBUTION.md

File metadata and controls

59 lines (37 loc) · 1.63 KB
Raw

Contributing to deepbots

Deepbots is an open source project, and we are always delighted to welcome new contributors!

There are many ways to contribute:

Got a Question or Problem?

If you have a question or problem to use weebots framework please ask on deepbots group

Found an issue?

If you find an bug, please raise an issue in https://github.com/aidudezzz/deepbots/issues

Please make sure that the bug comes from deepbots framework and not from Webots simulator.

Coding

There is always a lot of things to be done! Pull Requests are always welcome. If you are interested in contributing a use case example please refer to deepworlds repository.

If you are interested in code contribution please follow the guideline:

  • Clone the project:

    git clone https://github.com/aidudezzz/deepbots.git

  • It is totally recommended to use your virtual python environment.

    • virtualenvwrapper is a great tool with additional features for virtual environment building.

  • Pip install dev requirements

    pip install -r requirements/dev.txt

  • We are using pre-commit module for syntax and style checking.

  • Please rebase before opening a Pull Request.

  • Use atomic commits for the PRs.

  • If you are interesting in implementing and new feature, please open a tracking issue to make it known to us that you are working on it.

  • Reviews to other PRs are always welcome.

  • Please be patient on the reviews :)