docs: add pre-commit note (#16)

rickstaa · Aug 26, 2023 · e3c1819 · e3c1819
1 parent 52b77af
commit e3c1819
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -33,3 +33,6 @@ Please see the [docs](https://rickstaa.github.io/panda-gazebo-gym) for installat
 ## Contributing
 
 We use [husky](https://github.com/typicode/husky) pre-commit hooks and github actions to enforce high code quality. Please check the [contributing.md](https://github.com/rickstaa/ros-gazebo-gym/blob/noetic/contributing.md) before contributing to this repository.
+
+> \[!NOTE]\
+> We used [husky](https://github.com/typicode/husky) instead of [pre-commit](https://pre-commit.com/), which is more commonly used with Python projects. This was done because only some tools we wanted to use were possible to integrate the Please feel free to open a [PR](https://github.com/rickstaa/ros-gazebo-gym/pulls) if you want to switch to pre-commit if this is no longer the case.