Git 提交消息和变更日志生成框架 :book:

时间:2024-07-18 11:38:14
【文件属性】:

文件名称:Git 提交消息和变更日志生成框架 :book:

文件大小:434KB

文件格式:ZIP

更新时间:2024-07-18 11:38:14

git journal commit-conventions git-journal

git-journal:open_book:Git 提交消息和变更日志生成框架目录:TL; 博士安装用法默认输出模板输出提交消息准备和验证当前功能计划的功能和改进贡献TL; 博士维护变更日志可能很耗时,尤其是当多人在同一个项目上工作时。如果你维护一个单独的文件,合并冲突和额外的发布工作肯定会随之而来。有时在合并冲突解决期间完整条目丢失,人们忘记提及某些内容或问题与实际提交之间的链接丢失。如果我们可以使用git的提交历史来生成一个漂亮的变更日志,而无需任何额外的工作,那就太好了。这就是 git-journal 的用武之地。为了确保这种自动生成,需要一个框架来编写更合理的提交消息。单次提交消息应包含以标准化方式描述的项目的一个逻辑更改。这会导致更清晰的 git 历史记录,并为贡献者提供有关实际更改的更多信息。理论基础由两个 RFC 组成:RFC0001 用于提交消息语法扩展RFC0002 用于输出模板引擎安装要将git-journal用作 git 扩展,需要安装 Rust ,包括包管理器cargo 。不同的包管理器也会提供这些,例如通过 Arch Linux 上的Pacman :sudo pacman -S


【文件预览】:
git-journal-master
----.gitignore(230B)
----git-journal.zsh(8KB)
----benches()
--------bench.rs(569B)
----rfc()
--------0000-template.md(742B)
--------0001-commit-msg.md(4KB)
--------0002-output-templating.md(2KB)
----src()
--------parser.rs(35KB)
--------output.rs(3KB)
--------cli.yaml(3KB)
--------main.rs(5KB)
--------config.rs(6KB)
--------lib.rs(35KB)
----.travis.yml(2KB)
----Cargo.lock(26KB)
----LICENSE(1KB)
----Cargo.toml(1KB)
----git-journal.bash-completion(6KB)
----.gitmodules(201B)
----.github()
--------flow.png(17KB)
--------example.jpg(367KB)
--------dependabot.yml(212B)
----.gitjournal.toml(273B)
----README.md(15KB)
----tests()
--------commit_messages()
--------test_repo2()
--------template.toml(262B)
--------invalid_1.toml(61B)
--------NEW_COMMIT(308B)
--------invalid_3.toml(69B)
--------invalid_2.toml(65B)
--------COMMIT_EDITMSG(0B)
--------test_repo()
----git-journal.fish(4KB)
----appveyor.yml(650B)

网友评论