跳到主要内容

CHANGELOG 模板生成器

Keep a Changelog + Issue/PR 模板

CHANGELOG.md 预览
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/),
and this project adheres to [Semantic Versioning](https://semver.org/).

为什么需要 CHANGELOG 和模板

提交信息讲「每次改了啥」,CHANGELOG 讲「这个版本改了啥」——它是面向用户和协作者的人类可读变更记录。而 Issue / PR 模板,则是在别人想提 bug、提需求、提合并时,把关键信息一次性问全,少做无效沟通。

这三个东西,是开源项目「专业感」的基本门槛。

Keep a Changelog 规范

社区最通用的更新日志格式,核心规则很简单:

  • 倒序排列(最新的版本在最上面)
  • 每个版本按固定分类组织:Added / Changed / Deprecated / Removed / Fixed / Security
  • 每条变更用 - 列表项,动词开头、写清楚「做了什么」

示例骨架:

# Changelog

## [1.1.0] - 2026-08-05

### Added
- 支持微信登录

### Fixed
- 修复空输入时解析崩溃

GitHub 模板

把模板放进仓库的 .github/ 目录,提交后自动生效:

  • Issue 模板.github/ISSUE_TEMPLATE/bug.md.github/ISSUE_TEMPLATE/feature.md
  • PR 模板.github/PULL_REQUEST_TEMPLATE.md

提 Issue / PR 时,GitHub 会引导填写这些字段,避免「一句话 bug 描述」式的低质量反馈。

怎么用本工具

  1. 切到 CHANGELOG.md 标签:填版本号、日期,在六类里按行写变更,右侧实时生成标准文档,复制或下载 CHANGELOG.md
  2. 切到 Issue / PR 模板 标签:选 Bug / 功能 / PR 模板,按需编辑,复制或下载到 .github/ 对应路径。

相关工具

所有生成与下载都在你的浏览器本地完成,本工具不收集、不上传任何数据。

常见问题

为什么要写 CHANGELOG?
CHANGELOG 是给「人」看的项目变更记录,和给「机器」解析的提交信息互补。用户和协作者不必翻几百条 commit 就能知道「这个版本改了啥、有没有破坏性变更」。按 Keep a Changelog 规范写,结构统一、可读性强。
Keep a Changelog 的分类有哪些?
标准六类:Added(新增)、Changed(变更)、Deprecated(即将废弃)、Removed(已移除)、Fixed(修复)、Security(安全)。本工具按这六类组织输入,生成时自动加 `-` 列表项。
GitHub 的 Issue / PR 模板怎么用?
把生成的模板放进仓库的 `.github/ISSUE_TEMPLATE/`(Issue 模板,可多个)或 `.github/PULL_REQUEST_TEMPLATE.md`(PR 模板)。之后别人提 Issue / PR 时会自动套用,引导填写关键信息,减少来回沟通。
生成的文件怎么落地?
CHANGELOG 下载后保存为仓库根目录的 `CHANGELOG.md`;模板下载后按提示放进 `.github/` 对应路径即可生效。