Git 和变更日志指南

标签 git markdown bitbucket changelog

我是 git 的新手,我想知道创建标签和生成/维护变更日志的最佳实践。

直到现在,我总是创建一个 readme.md 并手动指出(在“变更日志”部分中)最重要的功能

例如:

version 1.0.1

  • changed layout in home
  • added slideshow in gallery
  • etc..

我如何创建具有这些特征的更新日志(也许是 markdown 格式)?

  • 根据个性化标题/标签标题/日期更改的标题
  • 基于标签或提交的更改

我还没有明确的想法,所以建议是正确的

提前致谢:)

最佳答案

目前还没有一些通用的指导方针。但是在 keep a changelog 上解释了很多好的规则。 .

正如他们提到的:

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

我完全同意。

这就是我创建 GitHub Changelog Generator 的原因根据所有这些准则生成变更日志。

实际上它只适用于 GitHub,但它提供了一个很好的例子来说明变更日志应该是什么样子。

它会根据您的标签、问题、标签和 pull 请求自动生成变更日志。

例如:这个变更日志是由这个脚本生成的: CHANGELOG.md

Changelog

1.2.5 (2015-01-15)

Full Changelog

Implemented enhancements:

  • Use milestone to specify in which version bug was fixed #22

Fixed bugs:

  • Error when trying to generate log for repo without tags #32

Merged pull requests:

  • PrettyPrint class is included using lowercase 'pp' #43 (schwing)

  • support enterprise github via command line options #42 (glenlovett)

关于Git 和变更日志指南,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/18182081/

相关文章:

git - 更改运行 Jenkins 进程的用户

node.js - Heroku 无法获取/

visual-studio - 将 Git Bash 与 Visual Studio 集成

latex - 如何控制 pandoc 生成的 latex 中的表?

python - 使用 Python 将 Markdown 表格转换为 html 表格

ssl - 安装SSL证书的私钥密码

bitbucket 分支显示类似 "MAIN" "DEVELOPMENT"的标签。这些标签是自动生成的

python3.8在mac上尝试git commit到bitbucket时没有这样的文件或目录

git - 在 github 中交叉引用提交

github - 在 GitHub 上的 Markdown 文件中应用颜色