From c82afdc524a0f6041f01aa9263c6b7c9aa91539a Mon Sep 17 00:00:00 2001 From: 7Wate Date: Tue, 25 Jan 2022 14:46:19 +0800 Subject: [PATCH] =?UTF-8?q?Git=20=E8=A7=84=E8=8C=83?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 3 +- docs/home.md | 4 ++ docs/{密码 => 安全}/GPG/GPG 简明笔记.md | 4 +- docs/标准/Git 规范.md | 84 +++++++++++++++++++++++++ 4 files changed, 91 insertions(+), 4 deletions(-) rename docs/{密码 => 安全}/GPG/GPG 简明笔记.md (98%) create mode 100644 docs/标准/Git 规范.md diff --git a/README.md b/README.md index 01916314..953f8ca5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ -# 7Wate`s Wiki +# 7Wate 维基知识库 -7Wate 个人维基知识库 ![Alt](https://repobeats.axiom.co/api/embed/b6e6a199e422ce596ea7423372746b6debadaa7d.svg "Repobeats analytics image") diff --git a/docs/home.md b/docs/home.md index b45b0181..4e02cdbc 100644 --- a/docs/home.md +++ b/docs/home.md @@ -8,5 +8,9 @@ sidebar_position: 1 欢迎访问 7wate 知识站点 ~ +笔记存在时效性，发现错误请邮箱联系 ~ + i💕 +![Alt](https://repobeats.axiom.co/api/embed/b6e6a199e422ce596ea7423372746b6debadaa7d.svg "Repobeats analytics image") + diff --git a/docs/密码/GPG/GPG 简明笔记.md b/docs/安全/GPG/GPG 简明笔记.md similarity index 98% rename from docs/密码/GPG/GPG 简明笔记.md rename to docs/安全/GPG/GPG 简明笔记.md index 6205b668..6febeb78 100644 --- a/docs/密码/GPG/GPG 简明笔记.md +++ b/docs/安全/GPG/GPG 简明笔记.md @@ -1,6 +1,6 @@ --- -id: GPG简明笔记 -title: GPG简明笔记 +id: GPG 简明笔记 +title: GPG 简明笔记 data: 2022年1月25日 --- diff --git a/docs/标准/Git 规范.md b/docs/标准/Git 规范.md new file mode 100644 index 00000000..52ce4fad --- /dev/null +++ b/docs/标准/Git 规范.md @@ -0,0 +1,84 @@ +--- +id: Git 规范 +title: Git 规范 +data: 2022年1月25日 +--- + +统一团队的 Git 工作流，包括分支工作流、Git commit 日志、tag 规范、README 模板、issue 模板，便于后续代码 review，版本发布以及日志自动化生成等等。 + + +## 分支工作流 + +![Git 分支工作流.png](https://static.7wate.com/img/2021/08/24/c5a50e99dde5f.png) + +**根据项目实际情况安排分支工作流！** + +## Commit 日志 + +日志所有内容务必使用 **ASCII** 字符，不要使用中文或 emoji，要求**最大化兼容**，便于程序处理。 + +commit 包括三个部分：**Header**、**Body**、**Footer**。 + +commit 格式如下： + +``` +([scope]): + +[body] + +[footer] +``` + +示例： + +``` +feature(auth): increase length of new API key + +the length is increased from 24 to 32 for new API keys + +close #12 +``` + +### 头部（Header） + +标题部分只有一行，包括三个字段：类型、说明、标题。 + +![commit-tag.png](https://static.7wate.com/img/2021/08/24/a26a82a44ce2e.png) + +- 破坏兼容性的改动，影响到依赖本项目的其它系统，请在类型后面加上**半角感叹号**「**!**」。 +- 标题务必不超过 **72** 个字符，务必精炼易懂。如无法限制在 **72** 个字符内，请拆分提交。 +- 描写部分**小写字母开头**、专有名词首字母大写、缩略语大写、结尾不用句号。 + +### 主体（Body） + +标题与正文间隔一个空行。 + +如果内容简单，请按照标题格式。超过一行，按照常规的段落格式。 + +**首字母大写，正确使用标点。可以多行、多段、每行不超过 72 个字符、行尾不出现空格、段落用空行隔开。** + +示例 + +``` +feature!(api): limit array length to 256 elements + +BREAKING: Array length limit is added to further limit request size. A +small number of existing apps may receive HTTP 413 "Payload too Large" +error. +``` + +### 脚注（Footer） + +正文与脚注间隔一个空行。 + +## Tag 规范 + +![语义化版本.png](https://static.7wate.com/img/2021/08/24/ad4999467e192.png) + +## Issue 模板 + +![Issue.png](https://static.7wate.com/img/2021/08/24/0e572570b1f3f.png) + +## README 模板 + +![Issue.png](https://static.7wate.com/img/2021/08/24/bdbf509e6b414.png)