Skip to content

Commit cc3e1a3

Browse files
committed
docs: add instructions to enable enforce-semantic-commit-message git hook
1 parent 9a951ae commit cc3e1a3

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,16 @@ DateTime strings in Azure Cosmos DB is `YYYY-MM-DDThh:mm:ss.fffffffZ` which foll
7474
7575
## Development
7676
77+
### Git hooks
78+
We use [pre-commit](https://github.com/pre-commit/pre-commit) library to manage local git hooks, as developers we just need to run in our virtual environment:
79+
80+
```
81+
pre-commit install
82+
```
83+
With this command the library will take configuration from `.pre-commit-config.yaml` and will set up the hooks by us.
84+
85+
Currently, we only have a hook to enforce semantic commit message.
86+
7787
### Test
7888
We are using [Pytest](https://docs.pytest.org/en/latest/index.html) for tests. The tests are located in the package
7989
`tests` and use the [conventions for python test discovery](https://docs.pytest.org/en/latest/goodpractices.html#test-discovery).

0 commit comments

Comments
 (0)