协作:重构完善
This commit is contained in:
parent
056639d977
commit
6995ccbc7c
@ -1,15 +1,17 @@
|
|||||||
---
|
---
|
||||||
title: 关于(Readme)
|
title: 关于(Readme)
|
||||||
description: Git 协作关于(Readme)
|
description: 本文提供了中英文双版本的README模板,包括项目简介、演示、原理图、安装指南、文档、FAQ、开发路线、更新历史、贡献指南、致谢和许可协议等部分。
|
||||||
keywords:
|
keywords:
|
||||||
- Git
|
|
||||||
- 协作规范
|
|
||||||
- README
|
- README
|
||||||
|
- 项目介绍
|
||||||
|
- 模板
|
||||||
|
- 安装指南
|
||||||
|
- 贡献指南
|
||||||
tags:
|
tags:
|
||||||
- 软件工程/Git协作
|
- 软件工程/Git协作
|
||||||
- 技术/软件工程
|
- 技术/软件工程
|
||||||
author: 7Wate
|
author: 7Wate
|
||||||
date: 2023-06-26
|
date: 2024-08-07
|
||||||
---
|
---
|
||||||
|
|
||||||
README 文件的命名应以项目的受众群体为依据。命名 README.md、README_EN.md、README_ZH.md。
|
README 文件的命名应以项目的受众群体为依据。命名 README.md、README_EN.md、README_ZH.md。
|
@ -1,10 +1,10 @@
|
|||||||
---
|
---
|
||||||
title: 开源协议(License)
|
title: 开源协议(License)
|
||||||
description: Git 开源协议(License)
|
description: 本文提供了开源项目LICENSE文件的命名和许可证向导链接,是项目法律声明和开源合规性的基础。
|
||||||
keywords:
|
keywords:
|
||||||
- Git
|
|
||||||
- 开源协议
|
- 开源协议
|
||||||
- 协作规范
|
- LICENSE
|
||||||
|
- 法律声明
|
||||||
tags:
|
tags:
|
||||||
- 软件工程/Git协作
|
- 软件工程/Git协作
|
||||||
- 技术/软件工程
|
- 技术/软件工程
|
@ -1,10 +1,11 @@
|
|||||||
---
|
---
|
||||||
title: 贡献者协议(Contributing)
|
title: 贡献者协议(Contributing)
|
||||||
description: Git 协作贡献者协议(Contributing)
|
description: 本文讨论了开源项目中贡献者协议的重要性,比较了CLA和DCO两种协议,并提供了贡献者协议的模板。
|
||||||
keywords:
|
keywords:
|
||||||
- Git
|
|
||||||
- 协作规范
|
|
||||||
- 贡献者协议
|
- 贡献者协议
|
||||||
|
- CLA
|
||||||
|
- DCO
|
||||||
|
- 开源协作
|
||||||
tags:
|
tags:
|
||||||
- 软件工程/Git协作
|
- 软件工程/Git协作
|
||||||
- 技术/软件工程
|
- 技术/软件工程
|
@ -1,10 +1,11 @@
|
|||||||
---
|
---
|
||||||
title: 分支(Branch)
|
title: 分支(Branch)
|
||||||
description: 分支
|
description: 本文规定了Git仓库中主要分支和辅助分支的命名和使用规则,包括主分支、开发分支、功能分支、预发布分支和热修复分支。
|
||||||
keywords:
|
keywords:
|
||||||
- Git
|
- Git 分支
|
||||||
- 分支
|
- 主分支
|
||||||
- 协作规范
|
- 开发分支
|
||||||
|
- 功能分支
|
||||||
tags:
|
tags:
|
||||||
- 软件工程/Git协作
|
- 软件工程/Git协作
|
||||||
- 技术/软件工程
|
- 技术/软件工程
|
@ -1,10 +1,12 @@
|
|||||||
---
|
---
|
||||||
title: 日志(Commit)
|
title: 日志(Commit)
|
||||||
description: Git 协作日志
|
description: 本文规范了Git Commit的格式,包括Header、Body和Footer,定义了不同类型、范围和主题的写法,以及如何描述不兼容的更改和关闭问题。
|
||||||
keywords:
|
keywords:
|
||||||
- Git
|
- Git Commit
|
||||||
- 协作
|
- 日志规范
|
||||||
- 日志
|
- Header
|
||||||
|
- Body
|
||||||
|
- Footer
|
||||||
tags:
|
tags:
|
||||||
- 软件工程/Git协作
|
- 软件工程/Git协作
|
||||||
- 技术/软件工程
|
- 技术/软件工程
|
@ -1,10 +1,10 @@
|
|||||||
---
|
---
|
||||||
title: 版本(Tag)
|
title: 版本(Tag)
|
||||||
description: Git 协作版本(Tag)
|
description: 本文介绍了Git版本命名和递增规则,遵循主版本号.次版本号.修订号的格式,明确了何时递增各类版本号。
|
||||||
keywords:
|
keywords:
|
||||||
- Git
|
- Git 版本
|
||||||
- 协作规范
|
- 语义化版本
|
||||||
- 版本
|
- 版本控制
|
||||||
tags:
|
tags:
|
||||||
- 软件工程/Git协作
|
- 软件工程/Git协作
|
||||||
- 技术/软件工程
|
- 技术/软件工程
|
@ -1,10 +1,11 @@
|
|||||||
---
|
---
|
||||||
title: 注释(Comments)
|
title: 注释(Comments)
|
||||||
description: Git 协作注释
|
description: 本文规定了代码注释的格式,包括行注释、关键字注释和版权注释的写法,强调注释应清晰、准确并位于适当位置。
|
||||||
keywords:
|
keywords:
|
||||||
- Git
|
- 代码注释
|
||||||
- 协作
|
- 版权
|
||||||
- 注释
|
- 关键字
|
||||||
|
- 格式规范
|
||||||
tags:
|
tags:
|
||||||
- 软件工程/Git协作
|
- 软件工程/Git协作
|
||||||
- 技术/软件工程
|
- 技术/软件工程
|
@ -1,10 +1,12 @@
|
|||||||
---
|
---
|
||||||
title: 交流反馈(Issue)
|
title: 交流反馈(Issue)
|
||||||
description: Git 协作交流反馈(Issue)
|
description: 本文规定了在Git协作中创建Issue的格式,包括新需求、缺陷反馈和答疑交流的模板,要求提供背景、思路、实现和报错信息。
|
||||||
keywords:
|
keywords:
|
||||||
- Git
|
- Git Issue
|
||||||
- 协作规范
|
|
||||||
- 交流反馈
|
- 交流反馈
|
||||||
|
- 需求
|
||||||
|
- 缺陷
|
||||||
|
- 答疑
|
||||||
tags:
|
tags:
|
||||||
- 软件工程/Git协作
|
- 软件工程/Git协作
|
||||||
- 技术/软件工程
|
- 技术/软件工程
|
@ -1,8 +0,0 @@
|
|||||||
{
|
|
||||||
"label": "协作规范",
|
|
||||||
"position": 1,
|
|
||||||
"link": {
|
|
||||||
"type": "generated-index",
|
|
||||||
"title": "协作规范"
|
|
||||||
}
|
|
||||||
}
|
|
Loading…
Reference in New Issue
Block a user