Skip to content

Commit

Permalink
Adding command to run the precommit hook to the README (#59)
Browse files Browse the repository at this point in the history
  • Loading branch information
blakejameson authored Dec 24, 2024
1 parent 1291bdf commit ae2b515
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,14 @@ We have a few python tools to make development safer, easier, and more consisten
3. Install required packages `pip install -r requirements.txt`

## Precommit hooks
Everytime you make a change in git, it's called a commit. We have a tool called a precommit hook that will run before you make each commit to ensure your code is safe and formatted correctly. To install the precommit hook:
Everytime you make a change in git, it's called a commit. We have a tool called a precommit hook that will run before you make each commit to ensure your code is safe and formatted correctly.

To install the precommit hook:
1. Install the precommit hook with `pre-commit install`

To run the precommit hook:
1. Run the precomit hook against all files with `pre-commit run --all-files`

## General Structure:
- **boot.py** This is the code that runs on boot and initializes the stack limit
- **cdh.py** This is the code that handles all the commands. A majority of this code is pulled from the cdh file developed by Max Holliday at Stanford.
Expand Down

0 comments on commit ae2b515

Please sign in to comment.