IAP GITLAB

Skip to content
Snippets Groups Projects
Commit 37070ef1 authored by Ralf Ulrich's avatar Ralf Ulrich Committed by Hans Dembinski
Browse files

Update CONTRIBUTING.md

parent 7dcb0172
No related branches found
No related tags found
No related merge requests found
...@@ -42,6 +42,30 @@ e.g. [link1](https://clangformat.com/) or ...@@ -42,6 +42,30 @@ e.g. [link1](https://clangformat.com/) or
[link2](https://zed0.co.uk/clang-format-configurator/). [link2](https://zed0.co.uk/clang-format-configurator/).
## CMAKE formatting
- command are lower cases, e.g. ```set (...)```
- variables upper case, e.g. ```set (VAR1 Text)```
Since cmake itself lacks structure almost entirely:
- put a space between command and start of parenthesis, e.g. ```command (...)```
- add two spaces for logical indent
```
if (condition)
do something
endif (condition)
```
- break long lines to start with new keyword in new line (indented)
```
install (
FILES ${CORSIKAstackinterface_HEADERS}
DESTINATION include/${CORSIKAstackinterface_NAMESPACE}
)
```
- add plenty of comments to all cmake code
- use expressive variables and functions
## Naming conventions ## Naming conventions
While `clang-format` does the structural formatting, we still need to agree on naming conventions: While `clang-format` does the structural formatting, we still need to agree on naming conventions:
......
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