Skip to content

Latest commit

 

History

History
76 lines (47 loc) · 2.71 KB

CONTRIBUTING_CN.md

File metadata and controls

76 lines (47 loc) · 2.71 KB

English / 中文

贡献代码

非常感谢能有心为FISCO-BCOS社区贡献代码!

分支策略

项目采用git-flow的分支策略。

  • master:最新的稳定分支
  • dev:待发布的稳定分支
  • feature-xxxx:一个正在开发xxxx特性分支
  • bugfix-xxxx:一个正在修bug xxxx的分支

贡献方法

Issue

可直接去issues page提issue。

修复bug

  1. Fork本仓库到个人仓库
  2. 从个人仓库的master分支拉出一个bugfix-xxxx分支
  3. 在bugfix-xxxx上修复bug
  4. 测试修复的bug
  5. PR(Pull Request)到本仓库的dev分支
  6. 等待社区review这个PR
  7. PR合入,bug修复完成!

开发新特性

  1. Fork本仓库到个人仓库
  2. 从个人仓库的dev分支拉出一个feature-xxxx分支
  3. 在feature-xxxx上进行特性开发
  4. 不定期的从本仓库的dev分支pull最新的改动到feature-xxxx分支
  5. 测试新特性
  6. PR(Pull Request)到本参考的dev分支
  7. 等待社区review这个PR
  8. PR合入,特性开发完成!

代码规范

参考CODING_STYLE

代码格式化

采用Clang-Format代码格式化工具,格式定义在文件.clang-format中。请用clang-format(推荐使用5.0或更高的版本)来格式化代码:

git clang-format          # to reformat the changes in the staging area and put the result into working directory
git clang-format -f       # to reformat the changes in the working directory
git clang-format <commit> # to reformat commits between specified commit and HEAD

持续集成(CI)

持续集成框架

  • travis-ci: Build Status (检查常规UT)

  • circleci: CircleCI(检查静态编译和国密)

代码覆盖率检查

  • codecov: codecov

代码质量

  • CodeFactor: CodeFactor

  • Codacy: Codacy Badge