コンテンツにスキップ
開発ガイドライン
Esc
↑↓移動↵開く⌘Jプレビュー
このページの内容

リポジトリ運用

Git の作業環境の準備、リポジトリの所有者と責任範囲、命名規則、可視性、README の整備

作業環境の準備

Git クライアント

Git クライアントはチームで統一する必要はなく、個人の好みで選択して構いません。

  • GUI: Sourcetree、GitKraken、GitHub Desktop
  • CLI: Git、GitHub CLI(gh)、lazygit
  • エディタ・IDE: Visual Studio Code、WebStorm など

初期設定

Git をインストールしたら、コミットの作成者として記録される名前とメールアドレスを設定します。 メールアドレスは GitHub アカウントに登録したもの(または GitHub の noreply アドレス)にしてください。登録されていないアドレスでコミットすると、GitHub 上でコミットがアカウントに紐づきません。

git config --global user.name "Taro Yamada"
git config --global user.email "taro@example.com"

所有者と責任範囲

役割

各リポジトリには次の役割を割り当てます。役割ごとの GitHub の権限レベルは 権限付与の原則を参照してください。

  • プロジェクトオーナー: プロジェクト全体の技術的な責任者。権限と保護ルールを管理する
  • テックリード・リードエンジニア: 日常的なコードレビューとマージを担当する
  • 開発メンバー: 機能開発やバグ修正を行う
  • 外部協力者: 案件単位で参加する社外のメンバー

責任範囲

リポジトリごとに次の担当者を決め、README の「体制」に記載します。

  • コードレビューの承認者
  • リリース判断の権限者
  • 本番デプロイの実行者
  • セキュリティインシデント対応者

コードレビューの承認者は .github/CODEOWNERS にも記載すると、PR 作成時にレビュアーとして自動で指定されます。

命名規則

リポジトリ名は次の原則に従って命名します。

  • 小文字とハイフンを使用する
  • クライアント略称+案件名の形にする(例: <クライアント略称>-<サイト・案件名>)
  • 短く、何のサイトか分かる名前にする
acme-corporate-site
acme-recruit-lp
Project1
test123
site
acme-site-2024-renewal-final

可視性

リポジトリの可視性は、原則 Private にします。次のような場合が該当します。

  • クライアントワーク
  • 社内システム
  • 機密情報を含むプロジェクト
  • 開発中のプロダクト

Public にするのは次の場合のみです。

  • オープンソースプロジェクト
  • 技術ブログのサンプルコード
  • コミュニティ向けツール
  • 採用活動用のポートフォリオ

リポジトリに含めないもの

次のファイルはコミットせず、.gitignore に追加します。

  • 機密情報を含むファイル(.env など。詳細は .env ファイルの管理)
  • 依存パッケージ(node_modules/)
  • ビルド成果物(dist/ など)
  • 容量の大きい動画や素材の元データ(PSD など)

大きなファイルは一度コミットすると履歴に残り続け、削除してもクローンが重いままになります。素材の元データはクラウドストレージなどで共有してください。

README の整備

すべてのリポジトリに、次の情報を含む README.md を用意します。

  • プロジェクトの概要
  • 必要な環境(Node.js のバージョンなど)
  • セットアップ手順と、必要な環境変数(.env.example を参照)
  • 開発環境の起動方法
  • 本番・ステージングの URL とホスティング先
  • デプロイとロールバックの方法
  • 体制(責任範囲の担当者)
  • ライセンス情報(オープンソースの場合)
# プロジェクト名

## 概要

〇〇株式会社のコーポレートサイトです。

## 必要な環境

- Node.js 24 以上
- pnpm

## セットアップ

```sh
pnpm install
cp .env.example .env
```

`.env` の各値はプロジェクトオーナーに確認してください。

## 開発サーバーの起動

```sh
pnpm dev
```

## 環境

| 環境 | URL | ホスティング |
| --- | --- | --- |
| 本番 | https://example.com | Cloudflare |
| ステージング | https://staging.example.com | Cloudflare |

## デプロイ

`develop` へのマージでステージング環境、`main` へのマージで本番環境へ自動デプロイされます。

問題があった場合は、Cloudflare のダッシュボードの Deployments から以前のバージョンに戻したうえで、原因のコミットを `git revert` で取り消します。

## 体制

- プロジェクトオーナー: 〇〇
- レビュー承認者: 〇〇

このページは役に立ちましたか?