From 7cb8ffc18f0e3774e9acf4aadfc703dee95cd8aa Mon Sep 17 00:00:00 2001 From: Derek Chen-Becker Date: Tue, 18 Nov 2025 22:03:46 -0700 Subject: [PATCH] org-contribute.org: Add section with git hook instructions These instructions go in concert with a set of changes to the Org codebase to provide new git hook scripts for commit validation. --- org-contribute.org | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/org-contribute.org b/org-contribute.org index 15773859..3a501631 100644 --- a/org-contribute.org +++ b/org-contribute.org @@ -506,6 +506,29 @@ Here is an example for such a message: TINYCHANGE #+end_example +** Git Hooks +:PROPERTIES: +:CUSTOM_ID: git-hooks +:END: + +The Org repository has a set of git hook scripts that can be used to +perform validation on commit messages and structure. If you would like +to utilize these scripts, you can link the existing files under the +~git-hooks~ directory into the ~.git/hooks~ subdirectory. If you +want to use all of the hooks, there is a Makefile target that does +this for you: + +#+begin_src shell +make githooks +#+end_src + +If you would like to remove the hooks, simply delete them from +~.git/hooks~ or run the Makefile target (~cleanall~ will also run this): + +#+begin_src shell +make cleangithooks +#+end_src + ** Producing ChangeLog entries If you are using [[https://magit.vc/][magit]] in Emacs, the ChangeLog for such entries can be -- 2.43.0