From 3aabf117bc4bc24a9a6718f226162890e88d7670 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Lemoine?= Date: Fri, 28 Sep 2012 16:23:51 +0200 Subject: [PATCH] CONTRIBUTING.md now mentions the precommit target --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0c7bfd323d..ee1f986004 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,6 +38,15 @@ Use the following to run the tests: This command assumes that the `phantomjs` command is on your PATH. +## The `precommit` target + +The Makefile includes a `precommit` target for running all of the +above (`lint`, `build-all`, `doc`, and `test`). As the name of the +target suggests `make precommit` is the command to run before +committing: + + $ make precommit + ## Commit messages We follow http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html