IAP GITLAB
Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
C
corsika
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Issue analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Antonio Augusto Alves Junior
corsika
Commits
2f276d78
Commit
2f276d78
authored
5 years ago
by
Ralf Ulrich
Committed by
Hans Dembinski
5 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Update CONTRIBUTING.md
parent
37070ef1
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
CONTRIBUTING.md
+23
-25
23 additions, 25 deletions
CONTRIBUTING.md
with
23 additions
and
25 deletions
CONTRIBUTING.md
+
23
−
25
View file @
2f276d78
...
...
@@ -42,30 +42,6 @@ e.g. [link1](https://clangformat.com/) or
[
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
While
`clang-format`
does the structural formatting, we still need to agree on naming conventions:
...
...
@@ -106,7 +82,7 @@ While `clang-format` does the structural formatting, we still need to agree on n
## Coding rules
-
Code may not introduce any compiler errors, or warnings
-
Code may not introduce any compiler errors, or warnings
(latter: on current CI runners)
-
All unit tests must succeed at all times. If tests fail, code is not merged.
-
We use C++17 concepts wherever useful and helpful
-
On any major error or malfunction we throw an exception. This is needed and required for complex physics and shower debugging.
...
...
@@ -121,6 +97,28 @@ While `clang-format` does the structural formatting, we still need to agree on n
-
When you contribute new physics algorithms, in addition you also need to provide a validation module
-
Code must be documented with
`doxygen`
commands
## 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
## Release versioning scheme
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment