Skip to content
This repository was archived by the owner on Mar 27, 2024. It is now read-only.

Commit 2068506

Browse files
authored
Add a git hook and instructions. (#129)
1 parent 19ae038 commit 2068506

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,23 @@ All submissions, including submissions by project members, require review. We
2121
use GitHub pull requests for this purpose. Consult
2222
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
2323
information on using pull requests.
24+
25+
## Tests
26+
27+
Before sending a PR, please make sure the included tests pass.
28+
You can run these by running
29+
30+
```shell
31+
make test integration
32+
```
33+
34+
from the project root.
35+
36+
You can also configure the included git hook to run tests automatically on commit.
37+
To do so, run:
38+
39+
```shell
40+
ln -s $(pwd)/hack/hooks/* .git/hooks
41+
```
42+
43+
from the project root.

hack/hooks/pre-commit

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
#!/bin/bash
2+
make test integration

0 commit comments

Comments
 (0)