Git ガイドライン

🔰 当ドキュメントは「コーディングガイドライン」の一部です。 基本的なガイドライン・ルールについては先にそれから確認してください。

🔰 前提

Gitの基礎知識

• 基礎講座（社内共有ドライブ内 Google スライド）

Gitクライアント

GUIのGitクライアントを利用して構いません。ターミナルからgitコマンドを利用しても良いですし、Visual Studio Codeの機能を使っても良いです。

🚧 ブランチとデモサイト

• devブランチはプッシュするとデモサイトに同期される
• 本番と同じ状態のブランチはmainブランチとする

devブランチとデモサイトの連携はSlackから@systemにリクエストしてください。

🎣 pre-commitフック

ソースコードの品質担保、そして修正忘れを防止するためにhuskyとlint-stagedによる、コミット直前のソースコードチェックを実行する仕組みを導入してます。 コミットを行うと、先にコードチェックが実行され、もしもコードに問題がある場合はコミットを強制的にキャンセルします。リントエラーなどを修正しないとコミットできません。

WARNING

GUI(fork など)を使う場合、ホームディレクトリに .huskyrc ファイルが必要になります。ファイルがない場合、チェックされないままコミットできてしまうので注意が必要です。

🔢 Git操作手順

初回リリースまで

• mainブランチは（まだ）利用しない。
• トピックブランチ他、ブランチの作成に制限は設けない（ただしプッシュし忘れ・マージし忘れなど注意）。
• コミットコメントは自由。可能であれば適切なコメントを入れる。空でも良い（リリース後はルールが変わる）。
• スピード重視で雑にコミットをしても構わない。

初回リリース時

1. devからmainブランチを切る。
2. yarn release コマンドを実行し、ファイルをリリース可能状態にする。
3. mainブランチをプッシュする。
4. リリース作業者はmainブランチをプルし、その状態のファイル郡を本番データとして扱い以下のいずれかを行う。
   • 本番サーバーへアップロード。
   • 本番サーバーへデプロイ。
   • htdocsフォルダをZipして納品。
5. リリースチェック・検品などが終わったら releaseYYYYMMDD の形式でタグを付けプッシュする。

重要

リリース作業をパートナー企業が行う場合であっても、1. 2. 3. 5. は 必ず社内の人間が責任をもって行うこと。