Skip to content

Latest commit

 

History

History
209 lines (162 loc) · 9.3 KB

CONTRIBUTING.rst

File metadata and controls

209 lines (162 loc) · 9.3 KB
Raw

Table of Contents

First off, thanks for taking the time to contribute!

The following is a short set of guidelines for contributing to Iroha.

How Can I Contribute?

Reporting Bugs

Bug is an error, design flaw, failure or fault in Iroha that causes it to produce an incorrect or unexpected result, or to behave in unintended ways.

Bugs are tracked as JIRA issues in Hyperledger Jira.

To submit a bug, create new issue and include these details:

Field What to enter
Project Iroha (IR)
Issue Type Bug
Summary Essence of the problem
Description What the issue is about; if you have any logs, please provide them
Priority You can use Medium though if you see the issue as a high priority, please choose that
Environment Your OS, device's specs, Virtual Environment if you use one, version of Iroha etc.

Reporting Vulnerabilities

While we try to be proactive in preventing security problems, we do not assume they?ll never come up.

It is standard practice to responsibly and privately disclose to the vendor (Hyperledger organization) a security problem before publicizing, so a fix can be prepared, and damage from the vulnerability minimized.

Before the First Major Release (1.0) all vulnerabilities are considered to be bugs, so feel free to submit them as described above. After the First Major Release please utilize a bug bounty program here in order to submit vulnerabilities and get your reward.

In any case ? feel free to reach to any of existing maintainers in Rocket.Chat private messages or in an e-mail (check CONTRIBUTORS.md file) if you want to discuss whether your discovery is a vulnerability or a bug.

Suggesting Improvements

An improvement is a code or idea, which makes existing code or design faster, more stable, portable, secure or better in any other way.

Improvements are tracked as JIRA improvements. To submit new improvement, create new issue and include these details:

Field What to enter
Project Iroha (IR)
Issue Type Improvement
Summary Essence of the idea
Description What the idea is about; if you have any code suggestions, you are welcome to add them here
Priority You can use Medium
Assign You can assign the task to yourself if you are planning on working on it

Asking Questions

A question is any discussion that is typically neigher a bug, nor feature request or improvement. If you have a question like "How do I do X?" - this paragraph is for you.

Please post your question in your favourite messenger so members of the community could help you. You can also help others!

Your First Code Contribution

Read our Rust Style Guide and start with beginner-friendly issues with JIRA label good-first-issue. Indicate somehow that you are working on this task: get in touch with maintainers team, community or simply assign this issue to yourself.

Pull Requests

  • Fill in the required template
  • Write tests for new code. Test coverage for new code must be at least 70% and to check coverage use cargo tarpaulin -v
  • Every pull request should be reviewed and get at least two approvals from maintainers team. Check who is a current maintainer in MAINTAINERS.md file
  • When you've finished work make sure that you've got all passing CI checks ? after that squash and merge your pull request
  • Follow the Rust Style Guide
  • Follow the Git Style Guide
  • Document new code based on the Documentation Styleguide
  • When working with PRs from forks check this manual

Tests and Benchmarks

  • To run tests execute cargo test command
  • To run benchmarks execute cargo bench command, if you want to debug output in benchmark, execute RUSTFLAGS="--cfg debug_assertions" cargo bench command

Styleguides

Git Style Guide

  • Sign-off every commit with DCO: Signed-off-by: $NAME <$EMAIL>. You can do it automatically using git commit -s
  • Use present tense ("Add feature", not "Added feature").
  • Use imperative mood ("Deploy docker to..." not "Deploys docker to...").
  • Write meaningful commit message.
  • Limit the first line of commit message to 50 characters or less
  • First line of commit message must contain summary of work done, second line must contain empty line, third and other lines can contain list of commit changes

Rust Style Guide

  • Use cargo fmt
  • Do not place code inside mod.rs files
  • Use domain-first modules structure. For example domain::isi::*. Such a way

complex uses will be easier to incude in dependent modules. - Do not use whitespaces or empty lines inside function bodies. - Put public methods first in your impl blocks. - Put inner modules after self module content, but before tests module.

Documentation Styleguide

  • Use Rust Docs

Places where community is active

Our community members are active at:

Service Link
RocketChat https://chat.hyperledger.org/channel/iroha
StackOverflo w https://stackoverflow.com/questions/tagged/hyperledger-iroh a
Mailing List hyperledger-iroha@lists.hyperledger.org
Gitter https://gitter.im/hyperledger-iroha/Lobby
Telegram https://t.me/hl_iroha
YouTube https://www.youtube.com/channel/UCYlK9OrZo9hvNYFuf0vrwww

Thank you for reading the document!