diff --git a/README.md b/README.md index 1dd898edd4bcd36a784e73440021af8019cef6d2..552d98aae3a500aa584f179aab074a6d26165052 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    + +## 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