13. Contribution Guidelines#

13.1. Reporting Bugs#

If you found a bug or any strange, unexpected behavior of the application or scripts, please create a Gitlab issue here: https://gitlab.cern.ch/g4see/g4see/issues

If you don’t have access to CERN GitLab, please post your issue on the G4SEE User Forum!

13.2. Feature requests, ideas#

Do you have a new idea? Missing an essential feature? Do you want to request a specific feature? If yes, please …

  • check existing Gitlab issues, and create a new GitLab issue with your request (see above)

  • join related discussion or start a new one on the G4SEE User Forum

  • consider contributing to the code (see below)

13.3. Contributing to the code#

If you are interested to contribute to G4SEE, please contact us at g4see.toolkit@cern.ch!

13.3.1. Coding style#

The .clang-format config file contains the G4SEE C++ coding style, all C++ source code in this repo should follow this coding style, which can be checked and enforced using the clang-format tool.

Dry-run (no files are being overwritten):

clang-format -style=file --dry-run -Werror -i {,src/}*.cc
clang-format -style=file --dry-run -Werror -i include/*.hh

C++ files are being overwritten:

clang-format -style=file -Werror -i {,src/}*.cc
clang-format -style=file -Werror -i include/*.hh

Python source code in this repo should follow the PEP8 coding style guide, which could be checked using the flake8 tool.

flake8 g4see-scripts/scripts/

13.3.2. Git commit messages#

  • +ADD added new files and/or major feature

  • +CHG changes in features/classes/functions, new minor feature

  • +FIX fixed bug(s)

  • +REF refactoring

  • +DOC updated documentation

  • +DEL deleted files

13.3.3. Copyrights#

Please check COPYRIGHT.md file for details.

13.3.4. Release a new version#

TBW.