First off, thanks for taking the time to contribute!
The following is a set of guidelines for contributing to CITA and its packages. These are mostly guidelines, not rules. Use your best judgement, and feel free to propose changes to this document in a pull request.
This section guides you through submitting a bug report for CITA. Following these guidelines helps maintainers understand your report , reproduce the behavior , and find the related reports .
When creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps others resolve issues faster.
After you’ve determined which repository your bug is related to, create an issue on that repository and provide the following information by filling in the template.
Explain the problem and include additional details to help maintainers reproduce the problem:
Include details about your configuration and environment:
[skip ci]
in the commit title:art:
when improving the format/structure of the code:racehorse:
when improving performance:scroll:
when writing docs:penguin:
when fixing something on Linux:apple:
when fixing something on macOS:checkered_flag:
when fixing something on Windows:bug:
when fixing a bug:fire:
when removing code or files:green_heart:
when fixing the CI build:white_check_mark:
when adding tests:arrow_up:
when upgrading dependencies:arrow_down:
when downgrading dependencies:shirt:
when removing linter warningsAll Rust must adhere to Rust Styleguide
Use Rust-clippy to improve your Rust codes by catching common mistakes.
Todo List
Here we use rustdoc as our code docs style standard.
Documents are essential parts to communicate with our users. We need to make our documents well-structured and readable. Everyone who contributes to the documents should have a strong responsibility for creating the great experience.
Everyone who modifies the documents needs to visualize the documents before making a pull request, in case there are some mistakes.
Separate Chinese and English characters by a blank space. [Chinese Version Only]
Example:
Bad Style:
我们采用 CITA 作为我们的blockchain基础设施服务。
Good Style:
我们采用 CITA 作为我们的 blockchain 基础设施服务。
Separate Chinese characters and numbers by a blank space. [Chinese Version Only]
Example:
Bad Style:
CITA 的速度超乎想象,比我用过的其他10几个区块链服务都要快。
Good Style:
CITA 的速度超乎想象,比我用过的其他 10 几个区块链服务都要快。
Please do remember to indent the contents below any ordered list or unordered list.
Example:
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。