Gaudi Contribution Guide

The Gaudi project is open source (see the LICENSE) and welcomes contributions from experiments and users.

To contribute to Gaudi development you can fork the project from CERN GitLab, where the Gaudi source is held.

Bug fixes and features should be developed in your own branch, then a merge request made back to the upstream Gaudi repository.

By submitting a merge request to the Gaudi repository you agree that your contribution will be copyrighted to CERN and covered by the Apache 2 licence, as per the LICENSE.

Building the documentation

The documentation can be built locally with Pixi, in a small dedicated environment (no need to configure and build Gaudi):

  • pixi run docs builds the Sphinx website (this documentation) and the Doxygen documentation (class reference) in build/site, with the same layout as the published one (the Doxygen documentation is in the doxygen subdirectory, and it is called local);

  • pixi run docs-serve does the same and serves the result on http://localhost:8000 (the list of the available versions of the Doxygen documentation is not shown if the pages are opened as local files);

  • pixi run docs-sphinx and pixi run docs-doxygen build only one of the two.

The configuration of Doxygen is in docs/doxygen.

AI coding assistants

The use of AI tools is permitted under the following conditions:

  • The developer is responsible for reviewing all AI-generated code and ensuring compliance with licensing requirements.

  • Commits with significant contributions from AI tools should have a commit trailer of the form Assisted-by: [LLM name/version].

  • The same note (or similar attribution) should also be added to the merge request description.

  • Comments on merge requests generated by AI tools should be clearly marked as such (e.g. as a quote).

Coding Style Guidelines

Code contributions to Gaudi should adhere to the clang-format rules (an automatic check is part of the Continuous Integration system).