Skip to content

Latest commit

 

History

History
43 lines (32 loc) · 1.66 KB

developer.md

File metadata and controls

43 lines (32 loc) · 1.66 KB

開発者向け資料

随時変更するかもしれませんが、現状の開発指針を示します。

コード規約

コードフォーマットの細かい規約は、今のところありませんが、以下に従っています。

  • インデントはタブ(4字幅)を使用します。
  • コメント文は、日本語または英語です。
  • テストコードはありません。手動で動作確認します。

Git コミットコメント

以下のフォーマットで書きます。

1行目:要約(後述のプレフィックス単語に続く英語の動詞句)
2行目:空行
3行目以降:変更の理由や詳細(日本語または英語)

1行目の要旨は、次の単語から始めることが多いです。(マージ時を除く)

プレフィックス単語 使用ケース
fix バグ修正
add 新規ファイルや新規機能追加
update 機能修正(バグではない)
change 仕様変更
clean リファクタ等の整理(機能変更なし)
disable 無効化
remove ファイルや機能の削除
revert 変更取り消し

コードの更新に伴う変更

機能追加・変更・削除した場合は、同時に次の修正を覚えておかなければなりません。

  • オプションページ
  • 機能説明のドキュメント

バージョンの変更は、バージョン番号を変更するだけのコミットを打ちます。バージョン番号の変更の際は、次の変更を行います。

  • manifest.jsonのバージョン情報
  • 更新履歴のドキュメント