mirror/pre-commit
1
0
Fork 0
mirror of https://github.com/pre-commit/pre-commit.git synced 2026-01-15 21:40:19 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update README to be more useful.

Browse Source
This commit is contained in:
Anthony Sottile
2014-03-16 19:56:15 -07:00
parent d5c93f94bc
commit 6bb0b121d6
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -4,3 +4,12 @@ pre-commit
A framework for managing and maintaining multi-language pre-commit hooks.
Some out-of-the-box hooks: https://github.com/pre-commit/pre-commit-hooks
## What is a "pre-commit"
A pre-commit is some code that runs before commiting code to do some spot-checking for some basic programming mistakes.
## Why make this project?
We noticed that when creating a git repo it was not convenient to create pre-commit hooks. Often we resorted to copy/paste to include a set of useful hooks. https://github.com/causes/overcommit is an awesome project, but locked us into ruby and system packages -- which we wanted to avoid.