search

zwhu / blog

嘛，写 blog 也要遵守基本法。
MIT License
66 stars 2 forks source link

组件 Changelog 标准 #38

Open zwhu opened 6 years ago

zwhu commented 6 years ago

Changelog

Branch-Name (0.0.2)

branch summary

Container Name (input)

summary

Container Name (select)

summary

详细介绍

Changelog 的二级标题是分支名，每个分支都是有自己的目标的（例如修复 bug，增加功能点等等），所以可以在分支下面附上一些简短的介绍分支功能（不建议很长，和之后要写的内容重叠）。summary 都是非必填但是推荐填写的。

Changelog 的三级标题是组件名称，Container 仓库的以组件为维度。

列表： [功能类型](Aone 的 id)：此次修改所做的事情的简短介绍。

列表的第一层级是独立事件，第二层级是第一层级的关联事件，深度为 2 层。

注意点

每次组件的提交都应该去更改 Changelog，这是对 Changelog 的持续维护。

一个组件有多个新功能点，分多次提交，那么每次提交都应该去修改 Changelog，标注此次更新内容。

一个组件只有一个新功能点，但是第一次提交的时候，以为自己的提交已经完成所有功能，但是实际情况是没有完成，那么就可以去更新 Changelog 为

### Container Name (input)

-[feat]: 增加 xxx 功能点
    * [feat]: 上一次代码完成的功能有哪些 ....
    * [feat]: 本次代码完成的功能有哪些....

Tips： 虽然原则是应该是最小化提交。每次 commit 都只做一件事，但是如果真的在一次 commit 里面做了多件事，改了多个 cotainer 的代码， 也是同样可以在 changelog 中修改多个 container 的内容。