跳到主要内容

参与贡献

贡献workflow​

1、从 fork 工程的 develop 分支 创建改动分支。

2、提交变更需要遵循 commit规范。

3、创建一个 pull request (PR) 指向develop分支，具体需要遵循PR规范。

4、大改动创建一个Issue，遵循Issue规范。

具体事项​

commit规范​

1、email 和 GitHub 的 email 一致

2、commit log 需要保持简练、规范，要求格式如下：

<type>: <description>

  • type 类型：

    • test 增加缺失的测试
    • feat 新功能
    • fix 问题修复
    • chore 构建过程或辅助工具更改
    • docs 文档更改

  • description 描述：

    • 总结性描述本次改动

PR规范​

🌀NOTE：一个PR不要过大，按照功能拆分成独立PR。

1、提交变更​

保持fork的工程代码内容最新​

fork工程的分支需要和github主仓库保持一致：

多个commit合并成一个​

  • 应保持有效commit数量，merge --squash 仅保留一个commit
  • commit信息应能反映当前 commit 的内容，不能随意描述： 查看 commit规范
git merge --squash feature/xxx --allow-unrelated-histories

git commit -m 'feat: xxxxx'

2、创建PR​

指定到主repo的develop分支​

PR描述规范​

Title： 功能/优化格式：

[Feature]: xxx

bug修复格式：

[Fix]: xxx

Description： 详细列出修改点，若有需要补充截图

改动原因：// 为什么要改

改动内容：// 详细描述改了什么

改动验证：// 怎么验证的

Issue：// issue链接

测试要求​

（待补充）

常见问题​

签署CLA​

在首次向 didi/xiaoju-survey 提交 Pull Request 时，会提示需要签署，以保证你的代码可以被合入。

1、查看 Pull Request 中的 Check 部分，找到 license/cla，并点击右侧 Details，进入 CLA 网站：

2、请阅读协议内容后单击 Sign in with GitHub to agree，页面将跳转回 Pull Request 页面。