コントリビューションガイド
コントリビューションを歓迎します。まず Issue で提案を共有していただけるとスムーズです。
ブランチポリシー
Section titled “ブランチポリシー”mainがリリースブランチ- 機能追加・修正は フィーチャーブランチ → PR → main マージ のフロー
- PR には Context (何を・なぜ) と Test plan (検証内容) を記載
PR 前に確認すること
Section titled “PR 前に確認すること”pnpm typecheck # 必須 (CI ゲート)pnpm lint # Biomepnpm test # テスト特に以下の変更ではテストの追加・更新を求めます:
- 認証・認可 (authn/authz) の変更 → 回帰テスト必須
- API 契約の変更 →
packages/sharedを更新し、API と Web の両側を検証 - DB スキーマ変更 →
apps/api/src/db/schema/database.tsと SQL マイグレーションを同時に更新
コミットメッセージ
Section titled “コミットメッセージ”Conventional Commits 形式 (feat: / fix: / refactor: / docs: 等) を使用します。
ドキュメントの同期
Section titled “ドキュメントの同期”- 安定したルール・規約 →
AGENTS.md - 実装された動作・運用手順 →
docs/ - 未完了の計画 →
plan/(実装済み内容は残さない) - ユーザー向けマニュアル →
apps/docs(本サイト)
リリースフロー
Section titled “リリースフロー”v*.*.*タグの push でPublish Releaseワークフローが発火- GHCR にイメージ公開 + GitHub Release 作成
- エンドユーザーは
scripts/update.shで更新 - 手動でのホスト直接変更は恒久手段にしない (ワークフロー経由を維持)
セキュリティ
Section titled “セキュリティ”脆弱性報告は公開 Issue ではなく、安全性に配慮したチャンネル (security advisory) を使用してください。シークレットをコミットに含めないでください。
詳細な開発規約はリポジトリの AGENTS.md を参照してください。