How to contribute to Qat

First of all, thank you for contributing to Qat!

Getting source code

You can either clone the Qat project or fork it to your own project. Qat uses a development process similar to the Git flow: the main development branch is called develop and contributions must be done in either a feature or a bugfix branch.

Simply create a branch named feature/<name> or bugfix/<name>.

Building

The building process is described in the Build instructions. Feel free to improve these instructions or submit an issue if you encounter any problem while building or using Qat.

Publishing your change

Commit and push your changes to Gitlab then open a Merge Request. Once the pipeline runs successfully and the Merge Request is approved, your changes will be merged into the develop branch and your branch will be deleted from the Qat repository.

In order for the pipeline to succeed:

• The Doxygen generation must not report any issue.

• The coding standard must be followed.

• The code must compile and link successfully for all supported Qt versions and platforms.

• The tests must pass for all supported Qt versions and platforms.

You are encouraged to make Merge Requests as small as possible. This helps reviewers focusing on your changes and find potential mistakes or flaws.

Coding style

TODO C++

Python code follows the PEP 8 Coding Style.

Documentation

C++ code is documented with Doxygen.

Python code is documented with Docstring Conventions