Skip to content

Latest commit

 

History

History
44 lines (28 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

44 lines (28 loc) · 1.89 KB

Contributing guidelines

To contribute, please follow this process:

1. Sign CLA agreement

Please sign it via GitHub credentials: Developer Certificate of Origin Version 1.1

2. Read Iroha working agreement

Iroha working agreement

3. Talk to us

Before writing any code, please discuss your intention with us, so that we can help you with your solution. It can also help to reduce situations with duplicated effort.

Do anything that is more convenient to you:

4. Check codestyle

Take a look briefly at CppCoreGuidelines and use clang-format to check your code style before creating pull request.

5. Get acquainted with design

As you are going to discuss your change in prior, we will help you to understand design of the system. Please, check architecture section to understand responsibilities of components and interfaces.

6. Test your code

Please, follow test policy for the code you write. New code should be covered by at least 80% (see coverage reports in pull requests).

7. Create pull request

Follow gitflow approach to create a branch for your code:

  • feature/whatever-feature-you-implement, create a branch from develop
  • fix/whatever-you-fix-in-develop
  • hotfix/whatever-you-fix-in-master

Follow the flow in Iroha working agreement.

Thank you for your interest to Iroha project!