diff options
| author | David Allsopp <david.allsopp@metastack.com> | 2017-04-11 13:23:32 +0200 |
|---|---|---|
| committer | David Allsopp <david.allsopp@metastack.com> | 2018-06-30 16:43:32 +0100 |
| commit | 546dd121cbd019d7b8ed795ae5ba69be02c9c0bf (patch) | |
| tree | a718148d2c2a5f3d3a190562d09fb1f3358c7e2a /CONTRIBUTING.md | |
| parent | 18bba745f3dca4d085069266ab650ca81a4e7d8b (diff) | |
| download | ocaml-546dd121cbd019d7b8ed795ae5ba69be02c9c0bf.tar.gz | |
Supply a Git pre-commit hook for tools/check-typo
Automatically runs tools/check-typo and rejects the commit if they don't
pass.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aae6f0ad83..7cfbf6b217 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -68,6 +68,9 @@ columns, not use tab characters (spaces only), and not use non-ASCII characters. These typographical rules can be checked with the script `tools/check-typo`. +If you are working from a Git clone, you can automate this process by +copying the file `tools/pre-commit-githook` to `.git/hooks/pre-commit`. + Otherwise, there are no strongly enforced guidelines specific to the compiler -- and, as a result, the style may differ in the different parts of the compiler. The general [OCaml Programming |