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
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
Pranav Sampathkumar
corsika
Commits
ebefb05c
Commit
ebefb05c
authored
5 years ago
by
ralfulrich
Committed by
Ralf Ulrich
4 years ago
Browse files
Options
Downloads
Patches
Plain Diff
update of coding style
parent
1ea2d6c2
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
CONTRIBUTING.md
+6
-3
6 additions, 3 deletions
CONTRIBUTING.md
with
6 additions
and
3 deletions
CONTRIBUTING.md
+
6
−
3
View file @
ebefb05c
...
@@ -51,8 +51,9 @@ While `clang-format` does the structural formatting, we still need to agree on n
...
@@ -51,8 +51,9 @@ While `clang-format` does the structural formatting, we still need to agree on n
-
Any static variable has a "g" prefix. A static member variable starts with "fg"
-
Any static variable has a "g" prefix. A static member variable starts with "fg"
-
Class member functions start with capital letters
-
Class member functions start with capital letters
-
Any class getter begins with "Get", and setter with "Set". Logical getters start with "Is" or "Has".
-
Any class getter begins with "Get", and setter with "Set". Logical getters start with "Is" or "Has".
-
enums should be "enum class"
and start with a capital "E"
-
enums should be "enum class"
-
Function parameter names start with "v"
-
Function parameter names start with "v"
-
Normal variable names in code start non-capital, and they cannot start with a "prefixed" v, f, fg, or g character
-
We use namespaces to avoid clashes and to structure code
-
We use namespaces to avoid clashes and to structure code
-
*Everything*
is part of the corsika namespace
-
*Everything*
is part of the corsika namespace
...
@@ -92,8 +93,10 @@ While `clang-format` does the structural formatting, we still need to agree on n
...
@@ -92,8 +93,10 @@ While `clang-format` does the structural formatting, we still need to agree on n
exposed to outside users, there might be pointers for very special cases
exposed to outside users, there might be pointers for very special cases
inside of classes.
inside of classes.
-
When you contribute new code, or extend existing code, at the same time provide unit-tests for all functionality.
-
When you contribute new code, or extend existing code, at the same time provide unit-tests for all functionality.
-
When you contribute new physics algorithms, in addition you also need to provide a validation module
-
When you contribute new physics algorithms, in addition you also need to provide a validation module (this is still TBD what exactly this means)
-
Code must be documented with
`doxygen`
commands
-
Code must be documented with
`doxygen`
commands extensively -> MAKE THIS INVESTMENT OF YOUR TIME EARLY, IT REALLY HELPS
-
There should not be any useless comments in code, in particular absolutely avoid to commit commented-out debug remnants
-
Add (extensively) meaningful comments to the code (only in English)
## CMAKE formatting
## CMAKE formatting
...
...
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