TrueCloudLab/distribution
13
0
Fork 3
Code Issues 3 Pull requests Projects Releases 2 Packages Wiki Activity Actions
distribution/project/hooks/README.md
Brian Bland 1a6893dbb6 Adds pre-commit hook, hook config script, and a README 
The pre-commit hook will automatically gofmt code in place, warning you
about any changes. It will also fail to commit if either golint or go
vet fails.
2014-12-15 18:09:11 -08:00

637 B
Raw Blame History

Git Hooks

To enforce valid and properly-formatted code, there is CI in place which runs gofmt, golint, and go vet against code in the repository.

As an aid to prevent committing invalid code in the first place, a git pre-commit hook has been added to the repository, found in pre-commit. As it is impossible to automatically add linked hooks to a git repository, this hook should be linked into your .git/hooks/pre-commit, which can be done by running the configure-hooks.sh script in this directory. This script is the preferred method of configuring hooks, as it will be updated as more are added.