Studio 規約 (TinyCorn Studio 標準)
スタジオのすべてのリポジトリ/ツールに適用されます。初期化からメンテナンスまでを対象とします。
言語
- ユーザーとのやり取り: 日本語。
- コード、識別子、コミットメッセージ、ブランチ名: 英語。
- README、CHANGELOG、リリースノート: 日本語。
最小限のリポジトリ構造
<repo>/
├── README.md # 必須
├── CHANGELOG.md # 必須 (Keep a Changelog)
├── LICENSE # 通常は MIT
└── .gitignore # 必須
README.md に含めるべきセクション
- はじめに (1～2文、そのツールが何をするのか、誰のためのものか)
- システム要件
- ビルド / 実行方法
- 主な機能 (グループ分け)
- ショートカットキー (UI がある場合)
- アーキテクチャ / ディレクトリ構造
- 設定 (UserDefaults、環境変数、設定ファイルなど)
- 既知の制限事項
- バージョン履歴 (概要、詳細は CHANGELOG に)
- ダウンロード (最新の GitHub Releases へのリンク — インストールファイルをリポジトリ内に置かないこと)
Git
- 最小限の
.gitignore:.build/、dist/、node_modules/、.DS_Store、ビルド時に自動生成されるリソースディレクトリ。 - コミットしてはいけないもの: インストールファイル (DMG/ZIP)、ビルド出力、シークレット/トークン。
- コミットメッセージ: 1行、命令形、英語、機能/修正内容を完全に説明。例:
Add folder view to Changes tab。 - コミットは機能単位で完全に行う。ユーザーから要求された場合、または機能完了が確認された場合のみコミットする。
- ブランチ:
mainは常にリリース可能な状態に保つ。機能は個別ブランチで開発し、完了後--ff-onlyでマージする。 - バージョン: SemVer に従い、一箇所のみで宣言する (例:
make-app.sh内のVERSION)。複数ファイルに分散させない。
ドキュメント
- README + CHANGELOG は機能と同時に更新する (後回しにしない)。
- すべてのリリースに含めるもの: 注釈付きタグ
vX.Y.Z+ 日本語のリリースノートを含む GitHub Release (release-flowスキルを参照)。 - 複雑な設計上の決定は、コード内または README の「アーキテクチャ」セクションに直接メモとして記録する。
品質
- 完了と報告する前に: ビルド/テストを再実行し、実際のデータまたはサンドボックスで検証する。
- UI: 適用前にプレビューする (
ui-preview-firstスキルを参照)。 - ユーザーの実際のデータへの書き込み/コミットテストは行わない — サンドボックスのコピーを使用する。
- テスト後はサンドボックス/一時ファイルをクリーンアップし、リポジトリにゴミを残さない。
新規リポジトリ チェックリスト
-
git init+ 標準.gitignore - 上記構造に従った README
-
[0.1.0]セクションを含む CHANGELOG - LICENSE (MIT)
- ビルドスクリプト (make-app.sh または同等) + DMG/インストーラ
- GitHub リモート +
mainへのプッシュ - インストールファイルを含む最初のリリース
- 今後のために
release-flowスキルを認識済み