Skip to content

Latest commit

 

History

History
52 lines (44 loc) · 2.81 KB

CONTRIBUTING.md

File metadata and controls

52 lines (44 loc) · 2.81 KB
Raw

Contributing to the IBM FHE Toolkit for Linux

Adding new features, improving documentation, fixing bugs, writing new tests, designing and coding new examples or writing tutorials are all examples of helpful contributions.

Prerequisites

All the prerequisites for contributions are already installed in every Docker container. They include C++ compiler and linker, cmake, clang-format, git tools, editors, plus the IBM HElib and its dependencies.

If you are new to GitHub, you can find useful documentation here, and information on the git version control system in this handbook.

Coding convention

This toolkit comprises a combination of bash scripts for building the Docker containers and C++14 for coding the examples, and it uses clang-format for C++ code formatting. When making code contributions to this toolkit, we ask you to follow the Shell Style Guide for bash scripting and the C++14 coding standard for C++ code. Please remember to format your C++ code using the clang format style file included in this distribution.

Steps to contribute

When contributing to IBM FHE Toolkit for Linux, we ask you to follow some simple steps:

  • Create a new git issue describing the type of contribution (new feature, documentation, bug fix, new tests, new examples, tutorial, etc) and assigning it to yourself, this will help to inform others that you are working on the contribution and if you want, it is also a vehicle to ask for help with it.
  • Create your own git fork of this repository to work on the intended contribution.
  • Once the contribution is complete, tested, documented and ready for review by the committer team, please initiate a GitHub pull request into the master branch from your fork of the repository.

Signing off your contribution

This project uses DCO. Be sure to sign off your contributions using the -s flag or adding Signed-off-By: Name<Email> in the git commit message. We will not be able to accept non-signed contributions.

Example commit message

git commit -s -m 'Informative commit message'