First off, thanks for taking the time to contribute!
The following is a short set of guidelines for contributing to Iroha.
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. |
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 |
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!
Read our C++ Style Guide and start with beginner-friendly issues with JIRA label [good-first-issue] <- click here. Indicate somehow that you are working on this task: get in touch with maintainers team, community or simply assign this issue to yourself.
-
Fill in the required template
-
End all files with a newline
-
Write tests for new code. Test coverage for new code must be at least 70%
-
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 C++ Style Guide
-
Follow the Git Style Guide
-
Document new code based on the Documentation Styleguide
-
When working with PRs from forks check this manual
- Sign-off every commit with DCO:
Signed-off-by: $NAME <$EMAIL>. You can do it automatically usinggit 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
- Use clang-format settings file. There are guides available on the internet (e.g. Kratos wiki)
- Follow CppCoreGuidelines and Cpp Best Practices.
- Avoid platform-dependent code.
- Use C++14.
- Use camelCase for class names and methods, use snake_case for variables.
- Use Doxygen.
- Document all public API: methods, functions, members, templates, classes...
Our community members are active at:
| Service | Link |
|---|---|
| RocketChat | https://chat.hyperledger.org/channel/iroha |
| StackOverflow | https://stackoverflow.com/questions/tagged/hyperledger-iroha |
| Mailing List | [email protected] |
| 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!