You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Before the readme, big shoutout to @dimaka-wix who's repo [commit-msg-hook](https://github.com/dimaka-wix/commit-msg-hook) was the basis for this repository. Go check out his repo for more information.
4
-
5
3
This hook is designed to be used with the [pre-commit](https://pre-commit.com/) hook framework. It will check your commit string against the provided regex.
6
4
7
-
### Utilizing
8
5
9
-
First you will need to setup [pre-commit](https://pre-commit.com/) using their documentation. Then you will be able to add this repository under it with the following:
6
+
### Using the commit-msg-regex-hook
7
+
8
+
First you will need to setup [pre-commit](https://pre-commit.com/) using their documentation.
9
+
10
+
Next you will need to enable commit message hooks:
11
+
`pre-commit install --hook-type commit-msg`
12
+
13
+
Finally you can add this to your .pre-commit-config.yaml:
If you would like to contribute to this project I am happy to accept contributions. Small note I use two spaces for indents and am not looking to swap.
31
+
32
+
Here is how you can contribute:
33
+
34
+
1. Fork the repo
35
+
2. Create a virtual envrionment `python -m venv venv`
36
+
3. Activate the virtual environment:
37
+
- Windows: `venv\Scripts\activate`
38
+
- Mac/Linux: `source venv/bin/activate`
39
+
4. Install the reqirements `python -m pip install -r requirements.txt`
40
+
5. Install our hooks:
41
+
-`pre-commit install`
42
+
43
+
And you are off to the races!
44
+
45
+
Before committing I would reccomend checking your build against unittest and the linter. If it doesn't pass it wont pass!
0 commit comments