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

Add a git hook and instructions. #129

Merged
merged 1 commit into from
Oct 27, 2017
Merged

Add a git hook and instructions. #129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,23 @@ All submissions, including submissions by project members, require review. We
use GitHub pull requests for this purpose. Consult
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
information on using pull requests.

## Tests

Before sending a PR, please make sure the included tests pass.
You can run these by running

```shell
make test integration
```

from the project root.

You can also configure the included git hook to run tests automatically on commit.
To do so, run:

```shell
ln -s $(pwd)/hack/hooks/* .git/hooks
```

from the project root.
2 changes: 2 additions & 0 deletions hack/hooks/pre-commit
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
#!/bin/bash
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure how to check file permissions in github, but can you make sure this is executable? The hook will be ignored if it isn't.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

$ ls -l hack/hooks/pre-commit
-rwxr-xr-x  1 dlorenc  eng  34 Oct 27 09:06 hack/hooks/pre-commit

make test integration