Merge pull request #2 from thedropbears/pre-commit

Add pre-commit to dev-requirements, run on existing files.
thedropbears · Jan 6, 2024 · ecd9f0a · ecd9f0a
2 parents d035e90 + b730d60
commit ecd9f0a
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 5 deletions.
diff --git a/.deploy_cfg b/.deploy_cfg
@@ -1,2 +1,2 @@
 [auth]
-hostname = 4774
+hostname = 4774
diff --git a/.gitignore b/.gitignore
@@ -50,4 +50,4 @@ dmypy.json
 ### WPILib ###
 networktables.json
 simgui*.json
-*.wpilog
+*.wpilog
diff --git a/.installer_config b/.installer_config
@@ -1,2 +1,2 @@
 [auth]
-hostname = 4774
+hostname = 4774
diff --git a/README.md b/README.md
@@ -11,9 +11,15 @@ pip install -r requirements-dev.txt
 ```
 
 ### Setup pre-commit
+Pre-commit is setup to automatically run formatters and linters when you commit. It is suggested to install pre-commit via pipx to keep it seperate from robot code dependencies. First [install pipx](https://pipx.pypa.io/stable/installation/).
 
-Pre-commit is setup to automatically run formatters and linters when you commit.
 
+Install pre-commit with pipx:
+```
+pipx install pre-commit
+```
+
+Setup the pre-commit hooks to run on commit:
 ```
 pre-commit install
 ```

diff --git a/ids.py b/ids.py
@@ -15,6 +15,7 @@ class TalonIds(enum.IntEnum):
     drive_4 = 4
     steer_4 = 8
 
+
 @enum.unique
 class CancoderIds(enum.IntEnum):
     swerve_1 = 1

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -1,3 +1,3 @@
 hypothesis
 pytest
--r requirements.txt
+-r requirements.txt