Skip to content

历史记录书写规范

偏右 edited this page Aug 26, 2013 · 11 revisions
  1. 历史记录文件放在模块根目录下,文件名为 HISTORY.md

  2. 书写格式参照 https://raw.github.com/aralejs/overlay/master/HISTORY.md

  3. 一切有价值的修改必须忠实地记录在文件中,推荐关联上对应的 issue 地址。

  4. Arale 模块的修改类型共有五项:

  • NEW #3 新增的属性、功能、方法、特性等等。
  • FIXED #15 修复 bug 和影响使用的性能问题等。
  • IMPROVED 接口增强、健壮性和性能提升、代码优化、依赖模块升级等。
  • CHANGED 涉及到兼容性变化的改动。
  • UNRESOLVED 已知的但本版本暂未修复的问题。
  1. 要在 aralejs.org/xxx/history.html 展现出图片标签的效果,需要按下列格式书写修改记录。
# History

---

## 1.0.1

`NEW` #2 增加 duration 参数。
`FIXED` #12 修复一个参数转换错误的问题。
`IMPROVED` 升级依赖版本到 `0.9.12``CHANGED` 删除 duration 参数。
`UNRESOLVED` 什么什么的问题。

## 1.0.0
`NEW` 新建组件。

效果预览

http://aralejs.org/overlay/history.html