Skip to content

Latest commit

 

History

History
41 lines (21 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

41 lines (21 loc) · 1.54 KB

如何参与贡献

很高兴你能有参与贡献的想法,以下是一些指南。

Bug 上报 & 提建议

Bug 与建议通过 Issues 进行管理和跟踪,希望在提新的 Issue 之前,你能简单浏览一下已有的 Issue,避免重复。

地址:https://github.com/mzlogin/guanggoo-android/issues

贡献代码

Bug 修复与提交新 Feature 建议通过 Pull requests 来进行,方便相互 Review,当然你也可以联系我将你添加为项目的 Collaborator 直接提交。

为了方便协作,我创建了一个名为 Kanban 的 Projects,大家可以方便地看到当前正在进行的任务与计划中的任务,Bug 和 Feature 都会有对应的 Issue,大家在 Issue 下面留言认领这些任务,我会将你设为该 Issue 的 Assignees,表示它归你了,其它人可以放心去干点其它事情。

所以,一个标准的贡献代码流程如下:

贡献流程

  1. Kanban 的 To Do 里找到你想做的任务,进入对应的 Issue 留言认领;

  2. 管理员把 Issue 的 Assignees 设为你,将任务委托给你完成;

  3. 完成任务;

  4. 发起 Pull request 或者直接 commit(如果你是 Collaborator);

  5. 代码 Review;

  6. Merge 代码。

Commit message

  1. 提交信息应该能明确表达你做了什么事情;

  2. 如果你用英文,那最好,如果你使用中文,那也行,但请尽量避免两种混用;

  3. 参考一下历史的 commit messages,尽量保持一致风格。