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
1bf54ed8
Commit
1bf54ed8
authored
6 years ago
by
Ralf Ulrich
Browse files
Options
Downloads
Patches
Plain Diff
Update GUIDELINES.md
parent
de079283
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
GUIDELINES.md
+22
-14
22 additions, 14 deletions
GUIDELINES.md
with
22 additions
and
14 deletions
GUIDELINES.md
+
22
−
14
View file @
1bf54ed8
...
...
@@ -7,6 +7,21 @@ or corsika-project@lists.kit.edu to get in touch with the project.
The CORSIKA Project decides on the
[
GUIDELINES
](
GUIDELINES.md
)
, and can
change them.
# How to contribute
-
We organize all development via
`Issues`
that may be feature requests,
ideas, or bugs fix requests.
-
New issues can be created, or existing issues
picked up.
-
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 and eventually discussed, and finally merged
into the master branch to close the issue.
## Code formatting
We rely on
`clang-format`
for code formatting. This has the tremendous
...
...
@@ -61,7 +76,6 @@ While `clang-format` does the structural formatting, we still need to agree on n
capital letter.
## Coding rules
-
Code may not introduce any compiler errors, or warnings
...
...
@@ -79,20 +93,14 @@ While `clang-format` does the structural formatting, we still need to agree on n
-
Code must be documented with
`doxygen`
commands
# How to contribute
-
We organize all development via
`Issues`
that may be feature requests,
ideas, or bugs fix requests.
-
New issues can be created, or existing issues
picked up.
-
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 and eventually discussed, and finally merged
into the master branch to close the issue.
## 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 frequently for
bug fixes or new features. Changes in z will not contain interface changes, thus, code will remain fully compatible.
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
...
...
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