登录

keep-a-changelog

olivierlacanMIT活跃维护 有专家点评

一份约定变更日志格式的规范与模板，帮开发者用 Markdown 清晰记录每次版本发布改了什么，方便用户和贡献者快速了解项目变化。

If you build software, keep a changelog.

v1.1.1发布于 2023-03-06 08:46 UTC6,754star +3 / 7 天3,534fork同步于 2026-11-11 05:31 UTC
变更日志版本发布Markdown规范版本管理
对比 GitHub 官网changeloggithistorymarkdownrelease

专家点评

上手难度：进阶更新于 2026-11-11

一份 Markdown 变更日志格式约定，用来替代散乱的 release notes 和提交记录

适用场景

  • 对外发布库或 SDK：需要一份用户能直接读的版本变更说明，替代从 git log 里扒 commit message 的做法，读者不用理解你的分支模型
  • 多版本长期维护的项目：用 Added/Changed/Fixed/Removed 固定分组，让 1.x 和 2.x 的变更记录结构一致，减少每次发版重新决定怎么写
  • 团队协作写 release notes：把格式约定写进 CONTRIBUTING，PR 里就能按同一套小节补条目，省掉发版前统一改写的返工
  • 需要给下游做 breaking change 提示：规范里有对应小节，比在 commit 里写感叹号更容易被使用者看到

踩坑

  • 这个仓库是官网生成器，不是能 npm install 的库。想直接引入代码做 changelog 解析或校验，会撞上「没有可用的包」这件事，得去别处找工具
  • README 里没有安装和运行命令，本地跑站点要先读 CONTRIBUTING.md，按 Haml 站点的构建流程配一遍
  • issue 里反复出现的是规范本身的语义分歧（如何标记 API breaking change、Unreleased 空标题的歧义、分组顺序、时态），说明这套约定在边界情况上没有唯一答案；团队落地前最好先就这几条内部定死，否则每次 review 都要重新吵

同类对比

要工具链而非规范，看 conventional-changelog / git-cliff 这类从 commit 生成 changelog 的项目；只想要托管式 release notes，GitHub Releases 本身就够，不必引入外部约定

怎么上手

由 README 提炼，执行前请确认
原文 
README 未说明，构建与开发步骤见 CONTRIBUTING.md
硬件要求按 README 说明

README 未说明

下载：源码 zip·GitHub Releases（安装包）本站不镜像安装包

项目说明

由 README 自动翻译提炼

Keep a Changelog 规范的官网源码仓库，用来生成 keepachangelog.com 站点

一份约定变更日志格式的规范与模板，帮开发者用 Markdown 清晰记录每次版本发布改了什么，方便用户和贡献者快速了解项目变化。

核心能力

  • 提供 Keep a Changelog v1.1.0 变更日志规范
  • 以 MIT 协议开源，可自由使用与修改
  • 仓库用于生成 keepachangelog.com 官网
  • 接受 Issue 与 PR 参与贡献
  • 翻译流程与开发任务写在 CONTRIBUTING.md

容易踩的坑

README 未给出安装与运行命令，需先阅读 CONTRIBUTING.md 才能本地跑起来；本仓库是官网生成器，不是可直接引入项目的库

内容由模型根据 README 生成，可能不完整或不准确，以官方文档为准。看原文 README

最近发版

5 个版本v1.1.1
全部 release
  1. v1.1.1v1.1.1 — Many new translations, centralized links, and more最新正式版2023-03-06 · 2023-03-06 08:46 UTC

    Added

    • Arabic translation (#444).
    • v1.1 French translation.
    • v1.1 Dutch translation (#371).
    • v1.1 Russian translation (#410).
    • v1.1 Japanese translation (#363).
    • v1.1 Norwegian Bokmål translation (#383).
    • v1.1 "Inconsistent Changes" Turkish translation (#347).
    • Default to most recent versions available for each languages
    • Display count of available translations (26 to date!)
    • Centralize all links into /data/links.json so they can be updated easily

    Fixed

    • Improve French translation (#377).
    • Improve id-ID translation (#416).
    • Improve Persian translation (#457).
    • Improve Russian translation (#408).
    • Improve Swedish title (#419).
    • Improve zh-CN translation (#359).
    • Improve French translation (#357).
    • Improve zh-TW translation (#360, #355).
    • Improve Spanish (es-ES) transltion (#362).
    • Foldout menu in Dutch translation (#371).
    • Missing periods at the end of each change (#451).
    • Fix missing logo in 1.1 pages
    • Display notice when translation isn't for most recent version
    • Various broken links, page versions, and indentations.

    Changed

    • Upgrade dependencies: Ruby 3.2.1, Middleman, etc.

    Removed

    • Unused normalize.css file
    • Identical links assigned in each translation file
    • Duplicate index file for the english version
  2. v1.1.01.1.0 — Be careful about inconsistent changelogs2019-11-11 · 2019-11-11 20:33 UTC
    查看更新说明

    Added

    • New paragraph on the risks of inconsistent changelog (and releases) in the Bad Practices section from @RichardLitt
  3. v1.0.01.0.0 — 6 new translations, brand new identity, and more.2017-06-20 · 2017-06-20 09:11 UTC
    查看更新说明

    Added

    • New visual identity by @tylerfortune8.
    • Version navigation.
    • Links to latest released version in previous versions.
    • "Why keep a changelog?" section.
    • "Who needs a changelog?" section.
    • "How do I make a changelog?" section.
    • "Frequently Asked Questions" section.
    • New "Guiding Principles" sub-section to "How do I make a changelog?".
    • Simplified and Traditional Chinese translations from @tianshuo.
    • German translation from @mpbzh & @Art4.
    • Italian translation from @azkidenz.
    • Swedish translation from @magol.
    • Turkish translation from @karalamalar.
    • French translation from @zapashcanon.
    • Brazilian Portugese translation from @Webysther.
    • Polish translation from @amielucha.
    • Russian translation from @aishek.
    • Czech translation from @h4vry.
    • Slovak translation from @jkostolansky.
    • Korean translation from @pierceh89.

    Changed

    • Start using "changelog" over "change log" since it's the common usage.
    • Start versioning based on the current English version at 0.3.0 to help translation authors keep things up-to-date.
    • Rewrite "What makes unicorns cry?" section.
    • Rewrite "Ignoring Deprecations" sub-section to clarify the ideal scenario.
    • Improve "Commit log diffs" sub-section to further argument against them.
    • Merge "Why can’t people just use a git log diff?" with "Commit log diffs"
    • Fix typos in Simplified Chinese and Traditional Chinese translations.
    • Fix typos in Brazilian Portuguese translation.
    • Fix typos in Turkish translation.
    • Fix typos in Czech translation.
    • Fix typos in Swedish translation.
    • Improve phrasing in French translation.
    • Fix phrasing and spelling in German translation.

    Removed

    • Section about "changelog" vs "CHANGELOG".
  4. v0.3.00.3.0 — Russian, Brazilian Portugese, Spanish translations.2017-06-20 · 2017-06-20 09:10 UTC
    查看更新说明

    Added

    • RU translation from @aishek.
    • pt-BR translation from @tallesl.
    • es-ES translation from @ZeliosAriex.
  5. v0.2.00.2.0 — It's not just about open source2017-06-20 · 2017-06-20 09:10 UTC
    查看更新说明

    Changed

    • Remove exclusionary mentions of "open source" since this project can benefit both "open" and "closed" source projects equally.

用户点评

登录用户的真实使用记录，可按版本和硬件筛选
共 0 条

    还没有人点评。第一个说出真实体验的人最有价值。

    README 原文

    未翻译
    在 GitHub 打开

    Keep a Changelog v1.1.0 badge Version 1.1.0 Badge MIT License Badge

    Don’t let your friends dump git logs into changelogs™

    This repository generates https://keepachangelog.com/.

    Contribute

    Please do contribute! Issues and pull requests are welcome.

    Development setup, common tasks, and the translation workflow are documented in CONTRIBUTING.md.

    Thank you for your help improving software one changelog at a time!

    相关项目

    同分类里 star 最高的项目
    对比全部 →
    gitignore
    github

    汇集各种语言和开发环境的 .gitignore 模板，帮你在初始化仓库时快速挑到合适的忽略规则，省去手写配置的麻烦。

    gitignore模板+3开发库 / 框架
    176541+35982k2026-11-09 17:05 UTC
    30-seconds-of-code
    Chalarangelo·JavaScript

    收录大量短小精悍的 JavaScript、CSS、Git 等代码片段与教程，帮开发者在几分钟内学会一个实用技巧，快速补齐日常开发所需知识。

    代码片段+4开发库 / 框架入门
    129482+4213kv14.0.02026-11-11 00:51 UTC
    devops-exercises
    bregman-arie·Python

    一套覆盖 Linux、Kubernetes、AWS、Terraform 等主题的 DevOps 练习题与面试题库，帮运维和 SRE 系统刷题、准备面试。

    DevOps 面试题+4开发库 / 框架入门
    86716+12721k2025-12-27 14:22 UTC
    lazygit
    jesseduffield·Go

    在终端里用键盘快捷操作完成提交、分支、rebase、cherry-pick 等 Git 日常操作，不用记命令，适合喜欢命令行但嫌 Git 命令繁琐的开发者。

    终端界面+4开发库 / 框架入门
    83814+1173.3kv0.66.32026-11-11 00:06 UTC