https://github.com/titpetric/git_hooks
Common git hooks to be used with git-hooks and git submodules across several projects
https://github.com/titpetric/git_hooks
Last synced: 6 months ago
JSON representation
Common git hooks to be used with git-hooks and git submodules across several projects
- Host: GitHub
- URL: https://github.com/titpetric/git_hooks
- Owner: titpetric
- Created: 2013-05-03T07:55:58.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2015-10-29T09:48:26.000Z (almost 10 years ago)
- Last Synced: 2025-01-31T13:11:56.788Z (8 months ago)
- Language: PHP
- Size: 188 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
git_hooks
=========
Common git hooks to be used with git-hooks and git submodules across several projects
What does it do?
----------------
The provided git hooks are pre-commit hooks. They are currently dealing with LINT
checks for various file types. What this means is, that if a file has invalid
syntax, git will not let you commit it into your repository, forcing you to fix it.
Short term goals are to verify:
- Javascript (using jshint)
- JSON checks
- PHP checks
- XML checks
- Unit testing (using phpunit)
Additional checks in the future could enforce
- CSS checks
- Commit message policy
Requirements
------------
- [git-hooks](https://github.com/titpetric/git-hooks) binary to install hooks
- php, bash, perl, diff, sed, awk (most of these probablly)
- Per-hook dependencies (...)
How to use it?
--------------
Adding the git_hooks to your project is dead simple.
First, be sure to install the [git-hooks](https://github.com/titpetric/git-hooks) binary:
```
wget https://raw.github.com/titpetric/git-hooks/master/git-hooks
chmod a+x git-hooks
```
Place the `git-hooks` file somewhere in your executable path.
In your git project root create a git_hooks submodule like this:
```
git submodule add git://github.com/titpetric/git_hooks.git git_hooks
```
Install the git hooks by running `git-hooks --install`. This will automatically
run the relevant git hooks for your project, and you can still cherry pick
which git hooks you wouldn't like to run manually. Running git-hooks without
--install option lists the hooks you have currently installed. You can take
a look at the [git-hooks project page](https://github.com/titpetric/git-hooks)
for more information about this.
If you want to update your git hooks, just go into the git_hooks
folder and issue a `git pull` to update them to the latest version.
Why?
----
I don't like to commit any kind of files with syntax errors. Improving our
development environment introduces policies and standards that need to be
enforced - if possible with automation.