Skip to content

Commit 48677b7

Browse files
committed
docs: add a contributing section
1 parent 8d428a2 commit 48677b7

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,17 @@ It's a pre-push hook and will always run
2929
Time is fleeting, we change services.
3030
Consequently to keep the code futureproof we don't
3131
want links to ephemeral thrid party stuff (slack, clubhouse, atlassian)
32+
33+
### Contributing
34+
35+
#### Debugging / testing
36+
Hooks can be tried locally using `try-repo`
37+
For example if I want to try `check-branch-linearity` from another repo
38+
I can do:
39+
```bash
40+
pre-commit try-repo path_to_this_repo/kp-pre-commit-hooks/ check-branch-linearity --hook-stage push --verbose
41+
```
42+
43+
#### Releasing a new version
44+
45+
To release a new version simple push a new tag with an increased version

0 commit comments

Comments
 (0)