CONTRIBUTING.md

Code style and naming

There are many coding guidelines which could be selected by the whole community, now we need a minimum to start with consistent code

C++

Code

• class names: PascalCase
• member functions: camelCase
• members: m_snake_case
• local variables: snake_case
• constands, definitions: SCREAMING_SNAKE_CASE
• base namespace: eicrecon
• indent: 4 spaces

File naming

• file extensions: cc, h
• factory names: WhatIsProduced_factory[_tag]
• services, processors, etc.: Name_service, Name_processor, Name_etc
• plugin with name should have name.cc file with InitPlugin function (It makes it so much easier to find the entry point of a plugin in the src tree)
• templated classes: end with "T" (classes that inherit from them don't, unless they are also a template)
• interface classes: start with "I"

Sample

(This code sample is temporary and needs further development)

#include <vector>

/** Doxygen style for Foo */
class Foo {
    friend class AnotherClass;

public:
    Foo(some_arg) {
        m_field = some_arg;
    }

private:
    int m_field;
};

class AnotherClass {
public:

    static const int MAX_VALUE = 42;
    static const int MIN_VALUE = 0;

    virtual void method1() = 0;
    virtual void method2() = 0;

    int  x() { return m_x; }
    void setX(x) { m_x = x; }

private:
    int m_x;

};

Python

• Strongly follow PEP-8 unless naming is dictated by C++ wrapping

Development policies

Use of data model classes

podio generates mutable and unmutable classes to work with underlying POD objects. e.g. TrackerHit (unmutable) an MutableTrakerHit. Unmutable variants are to be used for factory outputs and as a base classes of types that will be factory outputs:

class MyClass: public TrackerHit            // Yes
class MyClass: public MutableTrackerHit     // NO!

std::vector<const TrackerHit*> results          // Yes
std::vector<const MutableTrackerHit*> results   // NO!

spdlog as a main logging engine

spdlog is suggested as the main logging engine for EICRecon. Based on

One can use a general and plugin level loggers as

// Create plugin level sub-log
m_log = spdlog::stdout_color_mt("TrackerHitReconstruction_factory");

More documentation is available at spdlog