Contributing to the repo

[iliabaranov]

If you have a contribution you'd like to make, please fork this repo.

We use black and flake8 to format and lint our code, and this is checked for in a workflow on each commit to this repo.
(example HERE)

Once you are ready to submit a pull request, you should first run black and then flake8 to ensure your code is properly linted and formatted, else your pull request will fail.

This is very straightforward to do, as we've made a containerized image for both of these tools, along with the configuration file already in this repo for flake8.

Ensure you have installed docker, and then run each of the following in a terminal, within the caladan_examples folder:

docker run --rm   --mount type=bind,source="$(pwd)",target=/code   polymathrobotics/black .

docker run --rm   --mount type=bind,source="$(pwd)",target=/code   polymathrobotics/flake8 .

Happy pull requests!

Note: You can also replace the word docker in the above commands with podman if that is what you are using, just ensure your /etc/containers/registries.conf has an entry for docker.io