Skip to content
Snippets Groups Projects
Commit d0189d52 authored by juanf's avatar juanf
Browse files

SSDM-13365: Updated docs, git hooks

parent 4b2b5eda
No related branches found
No related tags found
1 merge request!40SSDM-13578 : 2PT : Database and V3 Implementation - include the new AFS "free"...
...@@ -123,7 +123,7 @@ The project does not uses modules yet. Add '--add-opens' statements manually whe ...@@ -123,7 +123,7 @@ The project does not uses modules yet. Add '--add-opens' statements manually whe
## Coding Style ## 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. 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 ...@@ -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 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 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") !["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
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment