added pre-commit to readme

Signed-off-by: Jakub Delicat <[email protected]>
husarion · Oct 20, 2023 · c1043bd · c1043bd
1 parent 77df36c
commit c1043bd
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 22 deletions.
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
diff --git a/.vscode/settings.json b/.vscode/settings.json
diff --git a/README.md b/README.md
@@ -108,6 +108,22 @@ ros2 launch rosbot_gazebo simulation.launch.py
 
 ## Testing package
 
+### pre-commit
+[pre-commit configuration](.pre-commit-config.yaml) prepares plenty of tests helping for developing and contributing. Usage:
+
+```bash
+# install pre-commit
+pip install pre-commit
+
+# initialize pre-commit workspace
+pre-commit install
+
+# manually run tests
+pre-commit run -a
+```
+
+After initialization [pre-commit configuration](.pre-commit-config.yaml) will applied on every commit.
+
 ### Industrial CI
 ```
 colcon test