13 lines
1.1 KiB
ReStructuredText
13 lines
1.1 KiB
ReStructuredText
Contribution
|
|
============
|
|
|
|
A long-term goal of this project is to provide a stable foundation of algorithms and data structures to enable a reliable and autonomous operation of a surface vehicle.
|
|
To achieve this goal, every addition or change to the software needs to be reviewed by the team and follow a set of rules as defined by our CI pipeline.
|
|
This obviously includes writing tests and documentation as needed.
|
|
|
|
To contribute to the project, feel free to create a new branch with a meaningful name and start your work from there.
|
|
If you feel that your work is ready to be merged into the master branch of the project, it is time to open a merge request.
|
|
|
|
If you are new to the Python programming language, you can find a good overview of Pythonic idioms `here <http://web.archive.org/web/20170316131252id_/http://python.net/~goodger/projects/pycon/2007/idiomatic/handout.html>`_.
|
|
We use `Google-style <https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html>`_ docstrings within the code and `Sphinx <https://www.sphinx-doc.org/en/master/>`_ to generate the documentation you are currently reading.
|