Skip to content

Commit

Permalink
add pre-commit docs
Browse files Browse the repository at this point in the history
  • Loading branch information
zaro0508 committed Jan 24, 2024
1 parent d1d655e commit 7dea15d
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,15 +119,18 @@ $ git checkout -b <branch-name>
As a pre-deployment step we syntatically validate files with
[pre-commit](https://pre-commit.com).

Please [install pre-commit](https://pre-commit.com/#install) then run
`pre-commit install` to setup the git hooks. Once configured the pre-commit
linters will automatically run on every git commit. Alternatively you
can manually execute the validations by running `pre-commit run --all-files`.
Run `poetry run pre-commit install` to setup the git hooks. Once configured
the pre-commit linters will automatically run on every git commit.
Alternatively you can manually execute the validations by running

```bash
$ poetry run pre-commit run --all-files
```

The CI for pre-commit has been offloaded to [pre-commit.ci](https://pre-commit.ci)
The configuration is in the [pre-commit-config.yaml](.pre-commit-config.yaml)
file.

## Unit Tests

Sceptre aims to be compatible with Python 3, please run unit test
Expand Down

0 comments on commit 7dea15d

Please sign in to comment.