5. Developing FCCSW

Sooner rather than later you will find it necessary write code for FCCSW. These pages cover some software development topics to remove any friction.

Contents:

• 5.1. Github workflow and contribution guide
  • 5.1.1. Overview
  • 5.1.2. First time setup of git
  • 5.1.3. Generate and set up ssh keys for github
  • 5.1.4. Improving your git experience
  • 5.1.5. Development workflow
    • 5.1.5.1. Keeping your local repository up to date
    • 5.1.5.2. Contributing code
  • 5.1.6. Recommendations
    • 5.1.6.1. General recommendations
    • 5.1.6.2. Commit comments
    • 5.1.6.3. Cleaning history
    • 5.1.6.4. Pull requests
  • 5.1.7. Trouble-shooting
    • 5.1.7.1. When I try to push to the repository, I get an authentication error
    • 5.1.7.2. I have cloned with https and now I can’t push my changes, what do I do?
  • 5.1.8. Need help?
• 5.2. CMake guide for the FCC software
  • 5.2.1. Overview
  • 5.2.2. Quick start into building FCCSW
    • 5.2.2.1. Set up the environment
    • 5.2.2.2. Using the top-level Makefile
    • 5.2.2.3. Using plain CMake
  • 5.2.3. CMake example packages
  • 5.2.4. CMake in the FCC software framework
    • 5.2.4.1. Runtime Environment
  • 5.2.5. CTest in FCCSW
  • 5.2.6. Using an internal library
  • 5.2.7. Building a new Gaudi module
  • 5.2.8. Using an external library
    • 5.2.8.1. Customizing how CMake is run
• 5.3. Writing Gaudi Algorithms
  • 5.3.1. Getting Started
  • 5.3.2. Exercise: Adding an Algorithm
• 5.4. Developing DD4hep Detector models
• 5.5. Guide to the Transition of FCCSW to EDM4hep
  • 5.5.1. Technical Information
    • 5.5.1.1. Build System
    • 5.5.1.2. Component source Code
      • 5.5.1.2.1. Generation / MCParticles
    • 5.5.1.3. Job options
• 5.6. Writing documentation for the FCC software
  • 5.6.1. Where to put documentation
  • 5.6.2. When and how is the documentation page updated?
  • 5.6.3. Structure of the content of the main page
  • 5.6.4. Running website generation locally
    • 5.6.4.1. About jekyll
  • 5.6.5. For website admins
  • 5.6.6. Custom Admonitions