branch: elpa/hyperdrive
commit 027fbd0a7ae62a83ae9cd88f6b6801ab54e1be86
Author: Joseph Turner <[email protected]>
Commit: Joseph Turner <[email protected]>
Meta: (CONTRIBUTING.org) Document git hooks
---
CONTRIBUTING.org | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/CONTRIBUTING.org b/CONTRIBUTING.org
index 54b5556461..537c9cdf2a 100644
--- a/CONTRIBUTING.org
+++ b/CONTRIBUTING.org
@@ -46,3 +46,13 @@ These steps should be followed when releasing a new version:
3. [ ] Rebuild .texi manual.
4. [ ] Commit changes.
+* Git hooks
+
+Please consider using the following git hooks:
+
+- [[file:tracked-hooks/pre-commit]]
+
+ This ~pre-commit~ hook helps ensure that the ~hyperdrive.texi~ is
+ rebuilt and committed at the same time as ~hyperdrive.org~. It
+ rebuilds ~.texi~ whenever ~.org~ is about to be committed, and it
+ prevents ~.org~ from being committed while ~.texi~ has unstaged changes.
