Changelog on Blog

チェンジログにブログのプラクティス

そして、爆速でドキュメントをパブリックに公開

octonsume

Profile

ogom

@ogomr

Commercial

Cookbook？ なにそれ？おいしいの？

chefguide

Demonstration

  • GitHub Pages
    • Websites for you and your projects.
  • Jekyll
    • Transform your plain text into static websites and blogs.
  • Bootswatch
    • Free themes for Bootstrap

octocat

Changelog Example

プロジェクトでチェンジログの使い方はいろいろです。

octojekyll

Format

書式はプロジェクトで統一されていれば、特に規定はありません。

  • Entry - 日付で変更を記録します。
  • Item - 変更の概要を記載します。

Entry Example

YYYY-MM-DD  Foo Bar  <foobar@example.com>

  * README.md: Fixed installation
  * README.md: Added new a File
  * Initial commit

Item English

英語でチェンジログはだいたいAddedかFixedで始まります。

英語 過去形 意味
Add Added 追加
Fix Fixed 修正
Change Changed 変更
Remove Removed 削除
Rename Renamed リネーム
Refactor Refactored リファクタリング

Thank You!

Tips

  • Rails Auto Document
  • RSpec to API Document
  • Model to State Diagram
  • Schema to Entity Relationship