このプロジェクトに興味を持っていただきありがとうございます！このプロジェクトをより良くするための貢献を歓迎します。
このプロジェクトでは、Git Flow をベースにしたシンプルなブランチ管理を行っています。
prod: 本番環境用ブランチ (デフォルト)。常に動作が保証された最新のリリースコミットが含まれます。stg: ステージング環境用ブランチ。新機能やバグ修正はまずここへマージされます。- 機能開発・バグ修正:
feat/やfix/プレフィックスをつけた独自のブランチを作成し、stgブランチへ Pull Request を送ってください。
- 最新の
stgブランチから作業用ブランチを作成します。 - 変更を加え、コミットします (コミットメッセージ規約を参照)。
stgブランチに向けて Pull Request を作成します。- ステージング環境へのデプロイと動作確認後、問題がなければ
stgにマージされます。 stgからprodへのプロモーションは、CIワークフローまたは管理者の操作によって行われます。
Conventional Commits 形式に従ってください。
feat:: 新機能fix:: バグ修正docs:: ドキュメントのみの変更style:: コードの意味に影響を与えない変更 (ホワイトスペース、フォーマットなど)refactor:: バグ修正も新機能追加も行わないコードの変更perf:: パフォーマンスを向上させる変更test:: 不足しているテストの追加や既存のテストの修正chore:: ビルドプロセスやドキュメント生成などの補助ツール、ライブラリの変更
- タイトルは短く簡潔に、目的がわかるようにしてください。
- 変更内容を具体的に記述してください。
- 可能な限り、変更内容に関連するスクリーンショットを添付してください。
- 破壊的な変更が含まれる場合は、その旨を明記してください。
このプロジェクトのインフラは Google Cloud 上で動作しており、Terraform で管理されています。
terraform/environments/stg: ステージング環境terraform/environments/prod: 本番環境terraform/modules: 共通モジュール
インフラの変更が必要な場合は、terraform/ ディレクトリ内のファイルを修正し、PRに含めてください。
- 基本的に ESLint の設定 (
eslint.config.mjs) に従ってください。 - ファイル名、定数、ディレクトリ名などは、プロジェクトの既存の命名規則に従ってください。
不安な点や質問がある場合は、Issue を作成するか、Pull Request 上でお気軽にお尋ねください。