-
Notifications
You must be signed in to change notification settings - Fork 0
历史记录书写规范
Alvin Hui edited this page Aug 1, 2013
·
1 revision
(本规范参照 Arale.js历史记录书写规范)
-
历史记录文件放在模块根目录下,文件名为 HISTORY.md。
-
书写格式参照 https://raw.github.com/aralejs/autocomplete/master/HISTORY.md
-
一切有价值的修改必须忠实地记录在文件中,推荐关联上对应的 issue 地址。
-
模块的修改类型共有五项:
-
NEW
#3 新增的属性、功能、方法、特性等等。 -
FIXED
#15 修复 bug 和影响使用的性能问题等。 -
IMPROVED
接口增强、健壮性和性能提升、代码优化、依赖模块升级等。 -
CHANGED
涉及到兼容性变化的改动。 -
UNRESOLVED
已知的但本版本暂未修复的问题。
- 要在 history.html 展现出图片标签的效果,需要按下列格式书写修改记录。
# History
---
## 1.0.1
`tag:new` #2 增加 duration 参数。
`tag:fixed` #12 修复一个参数转换错误的问题。
`tag:improved` 升级依赖版本到 `0.9.12`。
`tag:changed` 删除 duration 参数。
`tag:unresolved` 什么什么的问题。
## 1.0.0
`tag:new` 新建组件。