From 178fda593dad34169914a55eb01d1860d58bfd16 Mon Sep 17 00:00:00 2001 From: Shuo Wang Date: Fri, 26 Nov 2021 10:14:39 +0800 Subject: [PATCH] [docs] Refine documents for commit message tags. (#7215) --- .../commit-format-specification.md | 26 +++++++++---------- .../commit-format-specification.md | 6 ++--- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/en/developer-guide/commit-format-specification.md b/docs/en/developer-guide/commit-format-specification.md index 3dc4ce1f40..c41ea0ad0a 100644 --- a/docs/en/developer-guide/commit-format-specification.md +++ b/docs/en/developer-guide/commit-format-specification.md @@ -39,18 +39,18 @@ Commit is divided into ‘ title ’ and ‘ content ’ , the title should be l The types of this pull request are limited to the following types (all lowercase) - * fix：Bug fix - * feat-new：New function - * feat-opt：Optimization and improvement of original functions - * docs：Documents - * style：Code style adjustment - * typo：Code or Document correction - * refactor：Code refactoring (no function changes involved) - * optimize：Performance optimization - * test：Addition or repair of unit test - * chore：Modification of build tool - * revert：revert - * deps：Modification of third-party dependency Library + * fix: Bug fix + * feature: New feature + * improvement: Optimization and improvement for the original feature. + * docs: Documents + * style: Code style adjustment + * typo: Code or Document correction + * refactor: Code refactoring (no function changes involved) + * performance: Performance optimization + * test: Addition or repair of unit test + * chore: Modification of build tool + * revert: Revert a previous commit + * deps: Modification of third-party dependency Library Some tips： @@ -157,4 +157,4 @@ Commit is divided into ‘ title ’ and ‘ content ’ , the title should be l In my test, loading a table with 48 buckets, mem limit 2G, in previous version, the average memtable size is 44MB, after modification, the average size is 82MB - ``` \ No newline at end of file + ``` diff --git a/docs/zh-CN/developer-guide/commit-format-specification.md b/docs/zh-CN/developer-guide/commit-format-specification.md index cf82fcf552..5953067d9e 100644 --- a/docs/zh-CN/developer-guide/commit-format-specification.md +++ b/docs/zh-CN/developer-guide/commit-format-specification.md @@ -38,13 +38,13 @@ Commit 分为“标题”和“内容”。原则上标题全部小写。内容 本次提交的类型，限定在以下类型（全小写） * fix：bug修复 - * feat-new：新增功能 - * feat-opt：原有功能的优化和改进 + * feature：新增功能 + * improvement：原有功能的优化和改进 * docs：文档 * style：代码风格调整 * typo：代码或文档勘误 * refactor：代码重构（不涉及功能变动） - * optimize：性能优化 + * performance：性能优化 * test：单元测试的添加或修复 * chore：构建工具的修改 * revert：回滚