Skip to content

Latest commit

 

History

History
76 lines (51 loc) · 2.81 KB

CONTRIBUTING.md

File metadata and controls

76 lines (51 loc) · 2.81 KB
Raw

Contributing

The project

See here for more details on how the project works.

To summarise:

  • For issues that require changes in the functionality of the code (i.e. not documentation changes or typos) create a ticket on the ESS JIRA board with the label FW&FW.

  • These tickets need to be approved by the steering committee before work is started.

The repository

Branching

  • Branch your feature off 'main'

  • Create pull requests against 'main'.

Branch naming

The names should start with the JIRA ticket number and contain a brief description. For example:

ECDC-1014_byebye_dead_code

Skip the ticket number if you don't have access to the ESS JIRA :)

Pull requests

There is a template for pull requests. This should contain enough information for the reviewer to be able to review the code efficiently.

Code

Style

We use clang-format v3.9 LLVM default style. We try to follow the C++ Core Guidelines where possible. We currently use Doxygen for documentation, but try to keep it as simple as possible.

We used to follow the LLVM Coding Standards for naming conventions but in practice it was found to be difficult to read, so we are switching to a style similar to Python, e.g.,:

  • lower snake-case for variable and function names
  • capitalised words for class names

Private class members should have a leading underscore and that must be followed by a lowercase letter.

Regarding const, we try to stick to "east-const", e.g.

We prefer:
  void do_something(std::string const &str);

Rather than:
  void do_something(const std::string &str);

As we are migrating the style, one will see code in both styles. We suggest just fixing the style for code local to your current work. Eventually, we will eliminate the LLVM style.

Unit tests

Unit tests should be written/modified for any code added or changed (within reason, of course).

Integration tests

Integration tests should be written/modified for any changes that affect the "public" API of the application, i.e. anything that affects another component of the data streaming pipeline.

Sanitizers

To run one of the sanitizers add the appropriate flag to cmake:

cmake .. -DSANITIZER=address
cmake .. -DSANITIZER=thread

Note: the thread and address sanitizers cannot be ran at the same time.

File-maker app

This is a tool to help developers play with file-writing without requiring Kafka.

For example: it is useful for exploring the behaviour of the writer modules.

Note: it is currently a work in progress, so isn't very user friendly.