蓝鲸团队秉持开放的态度,欢迎志同道合的开发者一起贡献项目。在开始之前,请认真阅读以下指引。
MIT LICENSE 为 BK-MONITOR 的开源协议,任何人贡献的代码也会受此协议保护,贡献代码前也请明确是否可以接受该协议。
想要贡献代码,建议请先参照已有的特性文档和开发环境构建文档。
蓝鲸团队使用 issues 进行 bugs 追踪、特性追踪等。
当提交相关的 bug 时,请查找已存在或者相类似的 issue,从而保证不存在冗余。
如果确认该 bug 是一个新的 bug,提交时请包含以下的信息:
- 你所使用的操作系统信息
- 当前你使用的版本信息,例如 version,commitid
- 出现问题时,相关模块的日志输出
- 重现该问题的准确步骤,例如提交相关重现脚本/工具会比大量描述更有用一些
Pull Request (简称 PR)是我们使用的主流工作方式,请参考 Github 文档了解 PR 的功能。我们采用 "fork and pull" 的开发模式,即开发者首先向自己的 fork 仓库提交变更,然后向上游仓库发起 PR。
除非有特殊约定,所有 PR 提交的目标分支应始终选择 master
分支。注意提交 PR 时带着 issue 的编号。
提交建议的步骤:
1. fork 代码仓库(第一次操作);
2. 填写 issue;
3. 在个人仓库下切分支开发,建议按照"<分类>/<issue id>"来设定,比如: feature/#1;
4. 进行开发,此阶段可以根据开发进度自行设置commit;
5. 完成自测,请确保完成相关 issue 功能;
6. 向主仓库发起 PR(title 仓库默认使用 commit message),并指定好 code review 的负责人;
7. 按照 CR 的意见修改代码。为了避免 CR 负责人在本地反复清理 CR 分支此阶段允许 PR 发起人提交修复类的小 commit,一般使用`fixup:`作为 commit 前缀
8. CR 通过;
9. 仓库 master 角色完成 squarsh and merge;
10. 关闭 issue
因不同团队不同的项目管理下会有不同的代码提交注释,规范化开源下对不同团队提交信息,做了不同的提交标记以规范化区分提交内容:
git commit -m '标记: 提交的概要注释 issue #123'
示例:
git commit -m 'bugfix: 修复提交问题 #29'
标记 | 说明 |
---|---|
feature | 新特性 |
bugfix | 不重要的修改(换行,拼写错误等) |
optimization | 功能优化 |
sprintfix | 未上线代码修改 (功能模块未上线部分 bug) |
refactor | 功能重构 |
test | 增加测试代码 |
docs | 编写文档 |
merge | 分支合并及冲突解决 |