Philipp/ANN-route-predition
1
0
Fork 0
Code Issues 1 Activity

Added pyrate as a direct dependency.

Browse Source
This commit is contained in:
Philipp Horstenkamp
2022-07-11 23:07:33 +02:00
parent 8c4532dad4
commit c99d517f6f
230 changed files with 21114 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
pyrate/doc/source/contribution.rst Normal file
View File

@ -0,0 +1,12 @@
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.