Common Changelog 使用教程

Common Changelog 使用教程

common-changelogWrite changelogs for humans. A style guide.项目地址:https://gitcode.com/gh_mirrors/co/common-changelog

1、项目介绍

Common Changelog 是一个用于编写变更日志的样式指南，它基于 Keep a Changelog 并对其进行了更严格的定义。Common Changelog 强调变更日志必须由人类编写并为人类阅读，同时认识到一个干净的变更日志始于一个干净的 Git 历史。通过这种方式，Common Changelog 旨在提供一个清晰、一致且易于理解的变更日志格式。

2、项目快速启动

安装

首先，克隆项目到本地：

git clone https://github.com/vweevers/common-changelog.git
cd common-changelog

使用

在项目根目录下创建一个 CHANGELOG.md 文件，并按照 Common Changelog 的格式编写变更日志。以下是一个简单的示例：

# Changelog

## [Unreleased]

### Added
- 新增功能 A
- 新增功能 B

### Changed
- 修改功能 C

### Removed
- 移除功能 D

3、应用案例和最佳实践

应用案例

假设你正在开发一个开源库，你可以使用 Common Changelog 来记录每次发布的变更。例如：

# Changelog

## [1.0.0] - 2023-01-01

### Added
- 初始版本发布
- 新增功能 X
- 新增功能 Y

### Changed
- 优化功能 Z

最佳实践

1. 保持更新：每次发布新版本时，及时更新变更日志。
2. 清晰明了：确保每个变更条目都清晰明了，便于用户理解。
3. 避免自动化：不要使用自动化工具直接从 Git 日志生成变更日志，这样会导致变更日志质量下降。

4、典型生态项目

Common Changelog 可以与以下类型的项目结合使用：

1. 开源库：用于记录库的版本变更和新增功能。
2. Web 应用：用于记录应用的更新和修复。
3. 工具和框架：用于记录工具和框架的改进和新特性。

通过遵循 Common Changelog 的指南，可以确保你的项目有一个清晰、一致且易于维护的变更日志。

common-changelogWrite changelogs for humans. A style guide.项目地址:https://gitcode.com/gh_mirrors/co/common-changelog