Merge pull request #35 from ubclaunchpad/rwblickhan/#15-create-precom…

…mit-hook

Add pre-commit/post-merge hooks

README.md

@@ -32,4 +32,20 @@ environment like so:
 pipenv shell
 ```
 
-and then commands like `pycodestyle` and `pytest` can be run like normal.
+and then commands like `pycodestyle` and `pytest` can be run like normal.
+
+Additionally, we use [Travis CI](https://travis-ci.org/ubclaunchpad/rocket2.0) as
+a CI system. To run the same checks locally, we provide `scripts/build_check.sh`;
+this can be run with:
+
+```bash
+./scripts/build_check.sh
+```
+
+You can also install it as a
+[pre-commit hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) for git:
+
+```bash
+cd scripts/
+make install
+```

scripts/Makefile

@@ -0,0 +1,4 @@
+.PHONY: install
+install:
+	cp build_check.sh ../.git/hooks/pre-commit
+	cp update.sh ../.git/hooks/post-merge

scripts/build_check.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euxo pipefail
+pipenv run pycodestyle .
+pipenv run pydocstyle .
+mdl .
+pipenv run pytest tests/

scripts/update.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+set -euxo pipefail
+pipenv sync --dev