新規Git・GitHubプロジェクト設定チェックリスト

リポジトリの初期化、セキュリティ設定、CI/CD構築をスムーズに行うための手順。

プロジェクト開始時に以下の手順を実行し、コード品質とセキュリティを確保しましょう。

25 項目 · 5 セクション · programming git github developer software

PDFをダウンロード

進めながら項目にチェックを入れましょう。進捗はこのブラウザにのみ保存されます。

1. ローカル初期化

Gitリポジトリを初期化するプロジェクト根ディレクトリで `git init` を実行します。
.gitignoreファイルを作成するビルド生成物、OS設定ファイル、.envを含めます。
環境変数のサンプルファイルを作成するサンプル値を入れた `.env.example` を作成します。
コード品質・フォーマットツールを設定する ESLintやPrettierなどをプロジェクトに導入します。
初回コミットを実行する 'chore: initial project structure' などの分かりやすいログを残します。

2. GitHubリポジトリの作成

GitHub上で新しいリポジトリを作成するパブリックまたはプライベートを選択します。
ローカルリポジトリをリモートに接続する `git remote add origin <URL>` を実行します。
デフォルトブランチ名を main に変更する `git branch -M main` を実行します。
初回コミットをリモートにプッシュする `git push -u origin main` を実行します。
詳細な README.md を作成するセットアップ手順や使用方法を明記します。

3. セキュリティとルールの設定

ライセンスファイルを追加する MIT、Apache 2.0 など適切なライセンスを選択します。
シークレットスキャンとDependabotを有効化する設定画面から脆弱性検知を有効にします。
mainブランチの保護ルールを設定するマージ前のPRレビューとテストパスを必須にします。
IssueとPRのテンプレートを作成するテンプレートを `.github/` ディレクトリ内に配置します。
デプロイ用のシークレット情報を設定する APIキーを GitHub Actions Secrets に保存します。

4. CI/CDと自動化

テスト用の GitHub Actions ワークフローを作成する PRごとに自動テストが走るよう設定します。
自動コードチェックを設定するマージ前にスタイル違反がないか確認します。
デプロイパイプラインを設定するステージングおよび本番への自動デプロイを構築します。
ワークフローの動作を確認するテストPRを作成してパイプラインの成功を確認します。
貢献ガイドラインを作成する `CONTRIBUTING.md` ファイルを追加します。

5. 最終確認

機密情報がコミットされていないか確認するパスワードやトークンが履歴に含まれていないか検証します。
チームメンバーを適切な権限で招待する Write、Admin、Read などの権限を割り当てます。
別フォルダにクローンして動作確認する READMEの手順通りに起動できるかテストします。
最初のリリース jak タグを作成するセマンティックバージョニング（例: v0.1.0）を使用します。
一時ブランチや不要なファイルを整理する最初から清潔なリポジトリ状態を維持します。