Contributing to Hyperledger Caliper
We are using GitHub issues for bug reports and feature requests.
If you find any bug in the source code or have any trivial changes (such as typos fix, minor feature), you can raise an issue or delivery a fix via a pull request directly.
If you have any enhancement suggestions or want to help extend caliper with more DLTs or have any other major changes, please start by opening an issue first. That way, relevant parties (e.g. maintainers or main contributors of the relevant subsystem) can have a chance to look at it before you do any work.
All PRs must get at least one review, you can ask
hyperledger/caliper-committers for review.
Normally we will review your contribution in one week.
If you haven't heard from anyone in one week, feel free to @ or mail a maintainer to review it.
All PRs must be signed before be merged, be sure to use
git commit -s to commit your changes.
We use Travis Ci to test the build - please test on your local branch before raising a PR. More information on Travis, and linking to your github repository may be found here: https://docs.travis-ci.com/user/for-beginners/
There is also a RocketChat Channel for communication, anybody is welcome to join.
Caliper is modularised under
packages into the following components:
This is the Caliper CLI that enables the running of a benchmark.
Contains all the Caliper core code, used by adaptor implementations.
caliper-<adapter> is a separate package that contains a distinct adaptor implementation to interact with different blockchain technologies. Current adaptors include:
Each adaptor implements the
BlockchainInterface from the core package, as well as a
ClientWorker that are bespoke to the adaptor.
This is the integration test suite used for caliper; it runs in the Travis build and can (should) be run locally when checking code changes. Please see the readme within the package for more details.
Add an Adaptor for a New DLT
New adaptors must be added within a new package, under
packages, with the naming convention
caliper-<adaptor_name>. Each adaptor must implement a new class inherited from
BlockchainInterface as the adaptor for the DLT, as well as a
ClientWorker. For more information, consult our main documentation.