Git 贡献提交规范一
- 参考
feat
增加新功能fix
修复问题/BUGstyle
代码风格相关无影响运行结果的perf
优化/性能提升refactor
重构revert
撤销修改test
测试相关docs
文档/注释chore
依赖更新/脚手架配置修改等workflow
工作流改进ci
持续集成types
类型定义文件更改wip
开发中
仓库贡献规范二
Issues
如果您在使用过程中遇到任何问题,或者想提出任何建议,请在 **仓库 上新建您的 Issue。在新建 Issue 时,请先搜索 Issue,以确保您的问题没有被提出过。新建 Issue 时,请参考对应类型的模板。
Bug
- 标题:[Bug] xxxx 地方有 xxxxx 问题
- 内容:
- 使用的 ** 版本号
- 环境信息,包括操作系统、编译器、CMake 版本等
- 问题复现方式
- 期望现象
- 实际现象
- 问题出现时的日志或其他附加材料
Feature
- 标题:[Feature] 实现 xxxx 功能
- 内容:详细说明使用场景和需求内容
Pull requests
欢迎各位开发者提交代码共同建设 ***。您可以 Fork ** 仓库到您自己名下,然后推送一个 MR 到 ** 项目下,MR 将在 CI 流水线通过和管理员 Review 之后合入主干。
Pull Request template
Why is this PR required? What issue does it fix?:
when func is end, we need to stop timer.
What this PR does?:
when func is end, we need to stop timer.
Does this PR require any upgrade changes?:
If the changes in this PR are manually verified, list down the scenarios covered::
Any additional information for your reviewer? :
Mention if this PR is part of any design or a continuation of previous PRs
Checklist:
- Fixes #
- PR Title follows the convention of
<type>(<scope>): <subject>
- Has the change log section been updated?
- Commit has unit tests
- Commit has integration tests
- (Optional) Are upgrade changes included in this PR? If not, mention the issue/PR to track:
- (Optional) If documentation changes are required, which issue on https://github.com/openebs/website is used to track them: PLEASE REMOVE BELOW INFORMATION BEFORE SUBMITTING
The PR title message must follow convention:
<type>(<scope>): <subject>
.
Where:
-
type
is defining if release will be triggering after merging submitted changes, details in CONTRIBUTING.md. Most common types are:feat
- for new features, not a new feature for build scriptfix
- for bug fixes or improvements, not a fix for build scriptchore
- changes not related to production codedocs
- changes related to documentationstyle
- formatting, missing semi colons, linting fix etc; no significant production code changestest
- adding missing tests, refactoring tests; no production code changerefactor
- refactoring production code, eg. renaming a variable or function name, there should not be any significant production code changes
-
scope
is a single word that best describes where the changes fit. Most common scopes are like:- data engine (
localpv
,jiva
,cstor
) - feature (
provisioning
,backup
,restore
,exporter
) - code component (
api
,webhook
,cast
,upgrade
) - test (
tests
,bdd
) - chores (
version
,build
,log
,travis
)
- data engine (
-
subject is a single line brief description of the changes made in the pull request.
Private contact
您可以通过以下渠道联系我们:
- ***.com
参照模板:AimRT