Skip to content

Latest commit

 

History

History
45 lines (34 loc) · 2.87 KB

Contributing.md

File metadata and controls

45 lines (34 loc) · 2.87 KB
Raw

Contributing to the IBM Fully Homomorphic Toolkit for MacOS

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

We kindly request that any bug fixes be initiated through GitHub pull requests (PRs).

Prerequisits

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 setting up the environment and Objective C for coding the examples. When making code contributions to this toolkit, we ask you to follow the Shell Style Guide for bash scripting and the Objective-C Style Guide for Objective-C code. Any future contributions in Swift should follow the Swift Style Guild.

We also ask that contributions of new code for features come complete with unit tests for those new features.

Steps to contribute

When contributing to IBM Fully Homomorphic Toolkit for MacOS, 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'