Create CONTRIBUTING_COMMIT.md

bouxin · Nov 4, 2020 · 273ac51 · 273ac51
1 parent 1e8fc2a
commit 273ac51
Showing 1 changed file with 102 additions and 0 deletions.
diff --git a/CONTRIBUTING_COMMIT.md b/CONTRIBUTING_COMMIT.md
@@ -0,0 +1,102 @@
+# Commit 规范
+
+在对项目作出更改后，我们需要生成 Commit 来记录自己的更改。以下是参照 Angular 对 Commit 格式的规范：
+
+## (1) 格式
+
+提交信息包括三个部分：`Header`，`Body` 和 `Footer`。
+
+```
+<Header>
+
+<Body>
+
+<Footer>
+```
+
+其中，Header 是必需的，Body 和 Footer 可以省略。
+
+#### 1> Header
+
+Header 部分只有一行，包括俩个字段：`type`（必需）和`subject`（必需）。
+
+```
+<type>: <subject>
+```
+
+**Type**
+
+Type 用于说明 Commit 的类别，可以使用如下类别：
+
+- feat：新功能（Feature）
+- fix：修补 Bug
+- doc：文档（Documentation）
+- style： 格式（不影响代码运行的变动）
+- refactor：重构（即不是新增功能，也不是修改 Bug 的代码变动）
+- test：增加测试
+- chore：构建过程或辅助工具的变动
+
+**Subject**
+
+Subject 是 Commit 目的的简短描述。
+
+- 以动词开头，使用第一人称现在时，比如改变，而不是改变了。
+- 结尾不加句号（。）
+
+#### 2> Body
+
+Body 部分是对本次 Commit 的详细描述，可以分成多行。下面是一个范例。
+
+```
+More detailed explanatory text, if necessary.  Wrap it to 
+about 72 characters or so. 
+
+Further paragraphs come after blank lines.
+
+- Bullet points are okay, too
+- Use a hanging indent
+```
+
+**注意：**应该说明代码变动的动机，以及与以前行为的对比。
+
+#### 3> Footer
+
+	Footer 部分应该包含：(1)Breaking Changes;  (2)关闭 Issue；
+
+	**Breaking Changes**：
+
+	如果当前代码与上一个版本不兼容，则 Footer 部分以`BREAKING CHANGE`开头，后面是对变动的描述、以及变动理由和迁移方法。这种使用较少，了解即可。
+
+	**Issue 部分：**
+
+- 通过 Commit 关联 Issue：
+
+  如果当前提交信息关联了某个 Issue，那么可以在 Footer 部分关联这个 Issue：
+
+  ```
+  issue #2
+  ```
+
+- 通过 Commit 关闭 Issue，当提交到**默认分支**时，提交信息里可以使用 `fix/fixes/fixed` ， `close/closes/closed` 或者 `resolve/resolves/resolved`等关键词，后面再跟上 Issue 号，这样就会关闭这个 Issue：
+
+```
+closes #1
+```
+
+	注意，如果不是提交到默认分支，那么并不能关闭这个 Issue，但是在这个 Issue 下面会显示相关的信息表示曾经想要关闭这个 Issue，当这个分支合并到默认分支时，就可以关闭这个 Issue 了。
+
+#### 4> 例子
+
+下面是一个完整的例子：
+
+```
+feat: 添加了分享功能
+
+给每篇文章添加了分享功能
+
+- 添加分享到微信功能
+- 添加分享到朋友圈功能
+
+issue #1, #2
+closes #1
+```