From 6995ccbc7cff115aeedb5203e04f891cdbd499ce Mon Sep 17 00:00:00 2001 From: 7Wate Date: Wed, 7 Aug 2024 16:29:07 +0800 Subject: [PATCH] =?UTF-8?q?=E5=8D=8F=E4=BD=9C=EF=BC=9A=E9=87=8D=E6=9E=84?= =?UTF-8?q?=E5=AE=8C=E5=96=84?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../{关于(Readme).md => 1.关于(Readme).md} | 10 ++++++---- .../{开源协议(License).md => 2.开源协议(License).md} | 6 +++--- ...议(Contributing).md => 3.贡献者协议(Contributing).md} | 7 ++++--- .../{分支(Branch).md => 4.分支(Branch).md} | 9 +++++---- .../{日志(Commit).md => 5.日志(Commit).md} | 10 ++++++---- .../协作规范/{版本(Tag).md => 6.版本(Tag).md} | 8 ++++---- .../{注释(Comments).md => 7.注释(Comments).md} | 9 +++++---- .../{交流反馈(Issue).md => 8.交流反馈(Issue).md} | 8 +++++--- Tech/software-engineering/协作规范/_category_.json | 8 -------- 9 files changed, 38 insertions(+), 37 deletions(-) rename Tech/software-engineering/协作规范/{关于(Readme).md => 1.关于(Readme).md} (90%) rename Tech/software-engineering/协作规范/{开源协议(License).md => 2.开源协议(License).md} (68%) rename Tech/software-engineering/协作规范/{贡献者协议(Contributing).md => 3.贡献者协议(Contributing).md} (97%) rename Tech/software-engineering/协作规范/{分支(Branch).md => 4.分支(Branch).md} (92%) rename Tech/software-engineering/协作规范/{日志(Commit).md => 5.日志(Commit).md} (93%) rename Tech/software-engineering/协作规范/{版本(Tag).md => 6.版本(Tag).md} (75%) rename Tech/software-engineering/协作规范/{注释(Comments).md => 7.注释(Comments).md} (89%) rename Tech/software-engineering/协作规范/{交流反馈(Issue).md => 8.交流反馈(Issue).md} (90%) delete mode 100644 Tech/software-engineering/协作规范/_category_.json diff --git a/Tech/software-engineering/协作规范/关于(Readme).md b/Tech/software-engineering/协作规范/1.关于(Readme).md similarity index 90% rename from Tech/software-engineering/协作规范/关于(Readme).md rename to Tech/software-engineering/协作规范/1.关于(Readme).md index 87a8fb91..cdfedd22 100644 --- a/Tech/software-engineering/协作规范/关于(Readme).md +++ b/Tech/software-engineering/协作规范/1.关于(Readme).md @@ -1,15 +1,17 @@ --- title: 关于(Readme) -description: Git 协作关于(Readme) +description: 本文提供了中英文双版本的README模板,包括项目简介、演示、原理图、安装指南、文档、FAQ、开发路线、更新历史、贡献指南、致谢和许可协议等部分。 keywords: - - Git - - 协作规范 - README + - 项目介绍 + - 模板 + - 安装指南 + - 贡献指南 tags: - 软件工程/Git协作 - 技术/软件工程 author: 7Wate -date: 2023-06-26 +date: 2024-08-07 --- README 文件的命名应以项目的受众群体为依据。命名 README.md、README_EN.md、README_ZH.md。 diff --git a/Tech/software-engineering/协作规范/开源协议(License).md b/Tech/software-engineering/协作规范/2.开源协议(License).md similarity index 68% rename from Tech/software-engineering/协作规范/开源协议(License).md rename to Tech/software-engineering/协作规范/2.开源协议(License).md index 9707072e..95b17f15 100644 --- a/Tech/software-engineering/协作规范/开源协议(License).md +++ b/Tech/software-engineering/协作规范/2.开源协议(License).md @@ -1,10 +1,10 @@ --- title: 开源协议(License) -description: Git 开源协议(License) +description: 本文提供了开源项目LICENSE文件的命名和许可证向导链接,是项目法律声明和开源合规性的基础。 keywords: - - Git - 开源协议 - - 协作规范 + - LICENSE + - 法律声明 tags: - 软件工程/Git协作 - 技术/软件工程 diff --git a/Tech/software-engineering/协作规范/贡献者协议(Contributing).md b/Tech/software-engineering/协作规范/3.贡献者协议(Contributing).md similarity index 97% rename from Tech/software-engineering/协作规范/贡献者协议(Contributing).md rename to Tech/software-engineering/协作规范/3.贡献者协议(Contributing).md index d2be8567..d9837186 100644 --- a/Tech/software-engineering/协作规范/贡献者协议(Contributing).md +++ b/Tech/software-engineering/协作规范/3.贡献者协议(Contributing).md @@ -1,10 +1,11 @@ --- title: 贡献者协议(Contributing) -description: Git 协作贡献者协议(Contributing) +description: 本文讨论了开源项目中贡献者协议的重要性,比较了CLA和DCO两种协议,并提供了贡献者协议的模板。 keywords: - - Git - - 协作规范 - 贡献者协议 + - CLA + - DCO + - 开源协作 tags: - 软件工程/Git协作 - 技术/软件工程 diff --git a/Tech/software-engineering/协作规范/分支(Branch).md b/Tech/software-engineering/协作规范/4.分支(Branch).md similarity index 92% rename from Tech/software-engineering/协作规范/分支(Branch).md rename to Tech/software-engineering/协作规范/4.分支(Branch).md index 269dddcf..dd42afd0 100644 --- a/Tech/software-engineering/协作规范/分支(Branch).md +++ b/Tech/software-engineering/协作规范/4.分支(Branch).md @@ -1,10 +1,11 @@ --- title: 分支(Branch) -description: 分支 +description: 本文规定了Git仓库中主要分支和辅助分支的命名和使用规则,包括主分支、开发分支、功能分支、预发布分支和热修复分支。 keywords: - - Git - - 分支 - - 协作规范 + - Git 分支 + - 主分支 + - 开发分支 + - 功能分支 tags: - 软件工程/Git协作 - 技术/软件工程 diff --git a/Tech/software-engineering/协作规范/日志(Commit).md b/Tech/software-engineering/协作规范/5.日志(Commit).md similarity index 93% rename from Tech/software-engineering/协作规范/日志(Commit).md rename to Tech/software-engineering/协作规范/5.日志(Commit).md index 1fe71db0..e2e5a59c 100644 --- a/Tech/software-engineering/协作规范/日志(Commit).md +++ b/Tech/software-engineering/协作规范/5.日志(Commit).md @@ -1,10 +1,12 @@ --- title: 日志(Commit) -description: Git 协作日志 +description: 本文规范了Git Commit的格式,包括Header、Body和Footer,定义了不同类型、范围和主题的写法,以及如何描述不兼容的更改和关闭问题。 keywords: - - Git - - 协作 - - 日志 + - Git Commit + - 日志规范 + - Header + - Body + - Footer tags: - 软件工程/Git协作 - 技术/软件工程 diff --git a/Tech/software-engineering/协作规范/版本(Tag).md b/Tech/software-engineering/协作规范/6.版本(Tag).md similarity index 75% rename from Tech/software-engineering/协作规范/版本(Tag).md rename to Tech/software-engineering/协作规范/6.版本(Tag).md index 7c984f9d..19c30aa4 100644 --- a/Tech/software-engineering/协作规范/版本(Tag).md +++ b/Tech/software-engineering/协作规范/6.版本(Tag).md @@ -1,10 +1,10 @@ --- title: 版本(Tag) -description: Git 协作版本(Tag) +description: 本文介绍了Git版本命名和递增规则,遵循主版本号.次版本号.修订号的格式,明确了何时递增各类版本号。 keywords: - - Git - - 协作规范 - - 版本 + - Git 版本 + - 语义化版本 + - 版本控制 tags: - 软件工程/Git协作 - 技术/软件工程 diff --git a/Tech/software-engineering/协作规范/注释(Comments).md b/Tech/software-engineering/协作规范/7.注释(Comments).md similarity index 89% rename from Tech/software-engineering/协作规范/注释(Comments).md rename to Tech/software-engineering/协作规范/7.注释(Comments).md index a7609526..406615d8 100644 --- a/Tech/software-engineering/协作规范/注释(Comments).md +++ b/Tech/software-engineering/协作规范/7.注释(Comments).md @@ -1,10 +1,11 @@ --- title: 注释(Comments) -description: Git 协作注释 +description: 本文规定了代码注释的格式,包括行注释、关键字注释和版权注释的写法,强调注释应清晰、准确并位于适当位置。 keywords: - - Git - - 协作 - - 注释 + - 代码注释 + - 版权 + - 关键字 + - 格式规范 tags: - 软件工程/Git协作 - 技术/软件工程 diff --git a/Tech/software-engineering/协作规范/交流反馈(Issue).md b/Tech/software-engineering/协作规范/8.交流反馈(Issue).md similarity index 90% rename from Tech/software-engineering/协作规范/交流反馈(Issue).md rename to Tech/software-engineering/协作规范/8.交流反馈(Issue).md index 8ca81b2e..e66cf631 100644 --- a/Tech/software-engineering/协作规范/交流反馈(Issue).md +++ b/Tech/software-engineering/协作规范/8.交流反馈(Issue).md @@ -1,10 +1,12 @@ --- title: 交流反馈(Issue) -description: Git 协作交流反馈(Issue) +description: 本文规定了在Git协作中创建Issue的格式,包括新需求、缺陷反馈和答疑交流的模板,要求提供背景、思路、实现和报错信息。 keywords: - - Git - - 协作规范 + - Git Issue - 交流反馈 + - 需求 + - 缺陷 + - 答疑 tags: - 软件工程/Git协作 - 技术/软件工程 diff --git a/Tech/software-engineering/协作规范/_category_.json b/Tech/software-engineering/协作规范/_category_.json deleted file mode 100644 index 70727514..00000000 --- a/Tech/software-engineering/协作规范/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "协作规范", - "position": 1, - "link": { - "type": "generated-index", - "title": "协作规范" - } -} \ No newline at end of file