Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/developer_guide.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Developer Guide
===============

This section describes useful information for contributors of the project.

Commit Hook
------------

Contributing to the project you might be noting failed pipeline runs.
This can be due to the pre-commit hook finding errors in the formatting. Therefore, we suggest you run

.. code-block:: console

(.venv) pre-commit run --show-diff-on-failure --color=always --all-files

before committing your changes to GitHub.
This reformates the code accordingly, preventing errors in the pipeline.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,6 @@ Contents
pipeline
monitoring
training
developer_guide
api/index
references
15 changes: 0 additions & 15 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,21 +49,6 @@ Now, you can start each module, e.g. the `Inspector`:

(.venv) $ python src/inspector/main.py


Commit Hook
------------

Contributing to the project you might be noting failed pipeline runs.
This can be due to the pre.commit hook finding errors in the formatting. Therefore, we suggest you run

.. code-block:: console

(.venv) pre-commit run --show-diff-on-failure --color=always --all-files

before committing your changes to GitHub.
This reformates the code accordingly, preventing errors in the pipeline.


Configuration
-------------

Expand Down