From 29af0642243d91948ef332fe60f9ba8b9c776d87 Mon Sep 17 00:00:00 2001 From: Jacob Scott Date: Mon, 29 Jul 2019 11:41:15 -0700 Subject: [PATCH] add pre-commit instructions --- DEVELOPMENT.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 DEVELOPMENT.md diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 0000000..25af5c0 --- /dev/null +++ b/DEVELOPMENT.md @@ -0,0 +1,6 @@ +This repository uses [pre-commit](https://pre-commit.com/) to lint markdown, enforced on +PRs by [Travis CI](https://travis-ci.org/). Once you have +[installed](https://pre-commit.com/#install) pre-commit, you can locally lint (and +autofix) by running `pre-commit run --all-files` from the root of the repository. You +can add this behavior as a commit hook by running `pre-commit install` once, also from +the repository root.