Skip to content

Commit

Permalink
Update README per PR feedback [#39]
Browse files Browse the repository at this point in the history
* remove extraneous stop
* link pre-commit install docs
  • Loading branch information
genehack committed Jun 3, 2024
1 parent 0e19ca2 commit 4a1d3eb
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,13 +144,14 @@ For more locally testable scripts, Cram-style functional tests live in `tests` a
This repo is configured to use [pre-commit](https://pre-commit.com),
to help automatically catch common coding errors and syntax issues
with changes before they are committed to the repo.
.

If you will be writing new code or otherwise working within this repo,
please do the following to get started:

1. install `pre-commit` by running either `python -m pip install
pre-commit` or `brew install pre-commit`, depending on your
preferred package management solution
1. [install `pre-commit`](https://pre-commit.com/#install) by running
either `python -m pip install pre-commit` or `brew install
pre-commit`, depending on your preferred package management
solution
2. install the local git hooks by running `pre-commit install` from
the root of the repo
3. when problems are detected, correct them in your local working tree
Expand Down

0 comments on commit 4a1d3eb

Please sign in to comment.