CONTRIBUTING.md

# Guidelines for code development, structure, formating etc.

The CORSIKA Project very much welcomes contributions. Here we outlined
how you can find the right place to contribute, and how to do that.
Connect to https://gitlab.ikp.kit.edu and corsika-devel@lists.kit.edu (self-register at https://www.lists.kit.edu/sympa/subscribe/corsika-devel) to get in touch with the project.
The CORSIKA Project decides on the [GUIDELINES](CONTRIBUTING.md) and can decide to
change/improve them.

# How to contribute

  - We organize all development via `Issues` that may be feature requests,
    ideas, discussions, or bugs fix requests. 
  - New issues can be created, or existing issues
    picked up or contributed to. 
  - Issues are discussed in meetings or via  corsika-devel@lists.kit.edu  
    within the CORSIKA Project.
  - Issues are assigned to milestones. 
  - The work on issues is performed in `branches` that can be best
    created directly via the gitlab web interface. 
  - Proposed code to close one issue (located in a specific git
    branch) is reviewed, discussed, and eventually merged
    into the master branch to close the issue.
  - all merge request will undergo a code review, and must be approved before merge, in order to ensure high code qualtiy: [Code Approval Procedure](https://gitlab.ikp.kit.edu/AirShowerPhysics/corsika/-/wikis/Code-Approval-Procedure)


## Code formatting

We rely on `clang-format` for code formatting. This has the tremendous
advantage that definitely all code follows the same formatting rules,
and nobody at any point needs to invest time and effort into code
formatting. We provide a script `do-clang-format.sh`, which can be
very useful. But we urge everybody to integrate `clang-format` already
on the level of your source code editor. See [the official
page](https://clang.llvm.org/docs/ClangFormat.html) for information
about `clang-format` and its editor integration. At least: run
`do-clang-format.sh` prior to any `git add` command. Code with
improper formatting will not be accepted for merging. 

The definition of source code format is written down in the file
[.clang-format](.clang-format) and can be changed, if the CORSIKA
Project agrees on it. To see what is possible, check
e.g. [link1](https://clangformat.com/) or
[link2](https://zed0.co.uk/clang-format-configurator/).


## Naming conventions

While `clang-format` does the structural formatting, we still need to agree on naming conventions:

  - Classes and structs start with capital letters ```LikeThis```
  - Class member variables start non-captial and have a trailing "_" ```likeThis_```
  - Class member functions start with small letters ```LikeThis::doSomething(...)``` or ```LikeThis::do_something(...)```
  - Any class setter begins with "set_" ```LikeThis::set_something(...)```
  - Any class getter is named accoring to its property: ```LikeThis::something()```
  - Logical getters may start with ```is_``` or ```has_```
  - enums should be ```enum class``` 
  - Named variables start with small letter ```likeThis```
  - types in template definitions start with "T" ```TLikeThis```
  
  - use names that explain and document the code, thus for example
  ``` 
     TimeType TimeOfIntersection(Line const& line, Plane const& plane) {
         auto const line_direction = line.GetDirection();     
         auto const plane_normal = plane.GetNormal();     
         return plane_normal.dot(plane.GetCenter()-line.GetPosition()) / plane_normal.dot(line_direction);     
         }
  ```
    and not 
  ```
       TimeType TimeOfIntersection(Line const& l, Plane const& p) {
         auto const d = p.GetCenter() - l.GetR0();     
         auto const v = l.GetV0();     
         auto const n = p.GetNormal();     
         auto const c = n.dot(v);    
         return n.dot(d) / c;     
         }
  ```
    This actually is suffient to document the code, no further comments should be added in such cases. Only if further clarification is needed.  

  - We use namespaces to avoid clashes and to structure code
    - *Everything* is part of one of those namespaces:
       - ```corsika::framework```, ```corsika::physics```, or ```corsika::process```
    - All classes and objects are encapsulated into suited sub-namespaces,
      thus corsika, corsikaes, corsika::units, etc.
    - Namespace names do not use capital letters.  
    - Every header file is copied during build and install into
      "include/corsika/[namespace]" which also means, each header file
      can only provide definitions for a _single_ namespace. It is one
      main purpose of namespaces to structure the location of header
      files.
    - Each header file uses an include protection that includes at
      least the namespace name, and header file name, thus, `#ifndef
      __include_geometry_Point_h__` or `#ifndef __geometry_Point_h__`,
      or similar are acceptable.
    - Header files should always be included with `<..>`, thus,
      `#include <corsika/framework/geometry/Point.hpp>` since the build system
      will always provide the correct include directives (and files
      anyway cannot be found in file-system paths, which generally do
      not follow the namespace naming conventions outlined
      here).

  - Header files are named after the main class (or object) they
    define. This also means each header file name starts with a
    capital letter.
  

## Coding rules

  - Warnings should be fixed, when they appear on the system(s) currently used by the CI, by altering the code unless the warning originates from third-party code and cannot be fixed. In that case, the warning should be locally silenced with appropriate pragmas or by locally turning off warnings for that translation unit. 
  - All unit tests must succeed on the specified systems/configurations on gitlab-ci. If tests fail, code is not merged.
  - The unit test code coverage should not decrease due to a new merge request. 
  - We use C++17 features 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.
  - We never catch exceptions for error handling, there might be very few special exceptions from this. We need to discuss such cases.
  - Everything that should not change should be ```const```
  - Everything that does not need to be visible to the outside of a class/struct should be `private` or `protected`
  - We prefer the use of references, wherever useful
  - There cannot be any raw pointer in the interface of any class or object
    exposed to outside users, there might be (technical) raw pointers for very special cases
    inside of classes.
  - (member)functions that do something (are not just getters/setters), model actions or transformations, and should therefore be verbs. Classes are nouns.
  - 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 (this is still TBD what exactly this means)
  - 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 sufficient and meaningful comments to the code (only in English)
  
## 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

Releases of CORSIKA are thought to be the baseline for larger scale
testing, and full production.  The releases are numbered as x.y.z,
starting with x=8 form the gitlab c++ version. X will only be
incremented for major design or physics changes. The y index is
updated for new official releases that normally contain improved or
enhanced physics performance, and may also contain normal interface
changes to accomodate improvements. The z index can be updated more
frequently for bug fixes or new features. Changes in z will not
contain (major) interface changes, thus, production code will remain
fully compatible within changes of z.  Special releases of CORSIKA can
also have a tag name from git, e.g. as in the "milestone1" release.


# How to become scientific author of the CORSIKA Project

The CORSIKA Project decides on who becomes scientific author. The
following conditions are clearly sufficient, but not all of them are
required all the time:
  - responsibility for a particular functionality or software/management part 
  - have read and follow these [GUIDELINES](CONTRIBUTING.md)
  - active in the CORSIKA Project, that means responsive to
    discussions and problems in corsika-devel@list.kit.edu or on https//gitlab.ikp.kit.edu, 
    of relevant *Issues*,
    or in (phone) meetings
  - agreement to the [COLLABORATION_AGREEMENT](COLLABORATION_AGREEMENT.md) is strictly required
  - the members of the CORSIKA Project panel agree