Skip to content

Commit

Permalink
small readability updates to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
shaneknapp committed Nov 4, 2024
1 parent 6350957 commit 5c093a6
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,18 @@ our Github Actions CI/CD pipeline.

## Pre-Commit hooks: Installing

The previous step, `pip install -r dev-requirements.txt`, installs the package, pre-commit.
This is used to run a series of commands defined in the file, .pre-commit-config.yaml, to help ensure no mistakes are committed to the repo.
The previous step, `pip install -r dev-requirements.txt`, installs the package
[`pre-commit`](https://pre-commit.com/). This is used to run a series of
commands defined in the file [`.pre-commit-config.yaml`](https://github.com/berkeley-dsep-infra/datahub/blob/staging/.pre-commit-config.yaml)
to help ensure no mistakes are committed to the repo.

After the pip install command execute the following:
-- `pre-commit install`
-- `pre-commit run --all-files`
After you've installed `dev-requirements.txt`, execute the following two
commands:

```
pre-commit install
pre-commit run --all-files
```

## Setting up your fork and clones

Expand Down

0 comments on commit 5c093a6

Please sign in to comment.