Development¶

Git workflow¶

We use a fork-based workflow. The steps are:

1. Fork ShipSoft/FairShip on GitHub.

2. Clone your fork locally:

   git clone git@github.com:YOUR_USERNAME/FairShip.git
   cd FairShip
   

3. Add the official repository as a remote:

   git remote add official https://github.com/ShipSoft/FairShip.git
   

4. Keep your fork up to date:

   git fetch official
   git rebase official/master
   

5. Create a branch for your work:

   git checkout -b my-feature
   

6. Push and open a pull request:

   git push origin my-feature
   

   Then open a PR from your fork to ShipSoft/FairShip on GitHub.

Commit messages¶

• Write a short (< 72 characters) summary on the first line.
• Optionally add a blank line followed by a more detailed explanation.
• Code must at least compile before you open a PR.

C++ guidelines¶

See also the C++ Core Guidelines.

General¶

• NEVER use using namespace in headers.
• Prefer static_cast, dynamic_cast, or reinterpret_cast over C-style casts.
• Prefer range-based for loops.
• Prefer STL containers over ROOT containers.
• Prefer smart pointers over raw pointers.
• Consider using auto to reduce type verbosity.

FairRoot/FairShip specific¶

• Use LOG(SEVERITY) macros instead of std::cout or legacy FairLogger methods.
• Use TFile::Open rather than direct TFile constructors.
• Prefer STL vectors and RVec over TVectorT.
• Prefer std::string over const char* and TString.

Python guidelines¶

See also the Google Python Style Guide.

General¶

• ALWAYS use ruff format (for new code) and ruff check.
• ALWAYS place import statements at the top of the file.
• NEVER run non-trivial code at module top-level scope; hide it behind if __name__ == "__main__":.
• Prefer iterating over containers to manual indexing.
• Prefer argparse over getopt.
• Use f-strings or str.format() rather than %-formatting.

FairRoot/FairShip specific¶

• Prefer STL vectors, RVec, or GenVector over TVectorT.
• Prefer STL containers or RTensor over TMatrix.
• Use len() instead of .size() and .GetEntries() (supported for STL containers, TCAs, TTrees, Pythia8 events, and many other data types).

Getting help¶

Contact ship-software@cern.ch.