AGENTS コントリビューションワークフロー
このリポジトリでは、すべての機能開発において実装ファーストのワークフローを採用しています。
任意の機能開発に必要な手順
- 設計を先に行う
- 問題、目標、非目標、API/CLIのUX、エッジケースを記述します。
- 設計ドキュメントを
docs/に追加または更新します。
- 振る舞いを文書化する
- コマンドや機能が変更された場合は、ユーザー向けドキュメント(
README.md、docs/index.md)を更新します。
- コマンドや機能が変更された場合は、ユーザー向けドキュメント(
- テストを書く
- 新しいロジックに対する対象を絞った単体テストを、実装前または実装と同時に追加します。
- コードを実装する
- 変更は限定的にし、既存のプロジェクトスタイルと一貫性を保ちます。
- スキルを更新する
- コマンドセットやワークフローが変更された場合は、
skills/climate.mdとskills/climate-generator/SKILL.mdを更新します。
- コマンドセットやワークフローが変更された場合は、
- ローカルで検証する
- 以下を実行:
go build ./...go test ./...
- 開発中は迅速なフィードバックのために対象テストを実行します。
- 以下を実行:
- CIの健全性を検証する
- マージ前にPRチェックがすべて成功していることを確認します。
- コミットの規律
- 小さく意味のあるコミットを、明確なメッセージとともに行います。
- プッシュとPRの衛生管理
- ブランチを最新に保ち、PRの説明/チェックリストを最新に保ち、各レビューコメントに対応したコミットハッシュを記載してレビューコメントに返信します。
品質ルール
- 無関係なテストを削除したり、弱めたりしないでください。
- ドキュメントや移行ノートなしに、破壊的なCLI変更を導入しないでください。
- 決定論的な振る舞い(ソートされた出力、安定したイテレーション)を優先します。
- 生成物/マニフェストの振る舞いは、実用的な範囲で後方互換性を維持します。
機能チェックリストテンプレート
- 設計ドキュメントが追加/更新された
- README/ドキュメントが更新された
- スキルが更新された
- テストが追加/更新された
-
go build ./...が成功する -
go test ./...が成功する - CIチェックがすべて成功した