kratos社区希望能够得到广大开发者的帮助，所以希望您在要提 issue 或者 pull request 之前花几分钟来阅读一遍这篇指南。

Bug修复

kratos 使用 github issue 来管理问题。 如果您希望提交 bug 报告或帮忙修复bug时，请先确保已经搜索过已有的 issues 和 pull requests 并且阅读了我们的 常见问题。

提交 bug 报告时，请使用我们提供的 issue 模板，清楚地描述遇到的问题和复现方式，如果方便最好是可以提供一个最小复现仓库。

功能新增

如果您想改进或新增功能，推荐您也可以使用 issue 模板 来新建一个功能的 issue，并在 issue 中清晰的描述功能的需求。

如何提交代码

如果您从未在 github 上提交过代码，请跟随如下步骤：

  • 首先请 fork 项目到自己的 github 账户中
  • 然后基于 main 分支 创建一个新的功能分支，并以功能命名如 feature-log
  • 编写代码
  • 提交代码到远端分支
  • 在 github 中提交 PR 请求
  • 等待 review 后合并到 main 分支

Commit 提交规范

注意在您提交 PR 请求时首先保证代码使用了正确的编码规范，并有完整的测试用例，提交 PR 的信息中最好关联相关的 issue，以减轻审核人员的工作负担。

遵循 Conventional Commits 来规范化 commit message

  1. <type>[optional scope]: <description>
  3. [optional body]
  5. [optional footer(s)]

type

提交的 commit 类型主要有以下几种

主要类型

  • fix 修复 bug
  • feat 新增功能
  • deps 依赖修改
  • break 不兼容修改

其他类型

  • docs 文档修改
  • refactor 重构
  • style 代码格式
  • test 测试用例
  • chore 日常工作，如文档修改，示例等
  • ci 构建脚本

scope

提交的代码修改的代码文件范围：

  • transport
  • examples
  • middleware
  • config
  • cmd
  • etc.

description

用简短的话语清晰的描述提交的代码做了什么事

body

补充说明，用于描述原因、目的、实现逻辑等可以省略

footer

  • 当存在不兼容(breaking change)更新时，需要描述原因以及影响范围
  • 关联相关的 issue，如 Refs #133
  • 可能涉及到的文档更新和其他模块的更新的 PR 关联

examples

只有提交信息

  1. fix: The log debug level should be -1

需要引起关注

  1. refactor!(transport/http): replacement underlying implementation

包含全部结构

  1. fix(log): [BREAKING-CHANGE] unable to meet the requirement of log Library
  3. Explain the reason, purpose, realization method, etc.
  5. Close #777
  6. Doc change on doc/#111
  7. BREAKING CHANGE:
  8.   Breaks log.info api, log.log should be used instead

release 版本发布

release 时可以使用 kratos changelog dev命令生成 release 说明，工具会筛选出来从上一次 release 到现在的所有提交信息，然后根据提交的分类不同，主要汇总成以下几类

  • Breaking Change
  • Dependencies
  • Bug Fixes
  • Ohters

示例

通过 kratos changelog dev 生成的文本，只需简单修改即可作为 release 版本发布的说明

  1. ### New Features
  2. - feat(cmd): add kratos changelog command (#1140)
  3. - feat(examples): add  benchmark example (#1134)
  4. - feat: add int/int32/Stringer support when get atomicValue (#1130)
  5. ### Others
  6. - add form encoding (#1138)
  7. - upgrade otel to v1 rc1 (#1132)
  8. - http stop should use ctx (#1131)