From d0189d523029b2fd4a6022c1cfc7e48b475cd52b Mon Sep 17 00:00:00 2001
From: juanf <juanf@ethz.ch>
Date: Fri, 17 Feb 2023 16:42:52 +0100
Subject: [PATCH] SSDM-13365: Updated docs, git hooks

---
 README.md | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1dd898edd4b..552d98aae3a 100644
--- a/README.md
+++ b/README.md
@@ -123,7 +123,7 @@ The project does not uses modules yet. Add '--add-opens' statements manually whe
 
 ## Coding Style
 
-openBIS uses a particular coding style that guarantees all code is formatted uniformly.
+openBIS source code uses a particular style preset that guarantees all code is formatted uniformly.
 
 To make use of the preset go to File/Settings or IntelliJIDEA/Preferences depending on your OS.
 
@@ -133,3 +133,19 @@ Then import the XML file under 'docs/CISD_Conventions_IntelliJ_V2.xml'. See imag
 !["IntelliJ Code Style Configuration 2"](./docs/readme/intellij-codestyle-config-2.png "IntelliJ Code Style Configuration 2")
 !["IntelliJ Code Style Configuration 3"](./docs/readme/intellij-codestyle-config-3.png "IntelliJ Code Style Configuration 3")
 !["IntelliJ Code Style Configuration 4"](./docs/readme/intellij-codestyle-config-4.png "IntelliJ Code Style Configuration 4")
+
+## Git Hooks
+
+openBIS source code commit messages use a particular formatting.
+
+This formatting guarantees that there is a User Story behind it.
+
+To ensure commits follow the formatting 'Git Hooks' are provided.
+
+Just copy them from the root folder of this repo run the next command:
+````
+%/> cp ./docs/hooks/* ./.git/hooks/   
+%/> git add README.md
+%/> git commit -m "Test incorrectly formatted message"
+Aborting commit. Your commit message is missing an issue number ('SSDM-XXXXX:')
+````
\ No newline at end of file
-- 
GitLab