github-copilot-config

GitHub Copilot のグローバル設定を管理するリポジトリでございます。 .github/copilot-instructions.md に、全プロジェクト共通のコーディングルールや振る舞いの指示を記述しています。

---

ファイル構成

github-copilot-config/
├── .github/
│   └── copilot-instructions.md   # Copilot への共通指示ファイル
└── install.sh                     # 既存プロジェクトへの導入スクリプト

---

適用方法

推奨: curl スクリプトによる導入 VS Code / CLI いずれの利用形態でも、プロジェクト直下の .github/copilot-instructions.md があれば GitHub Copilot は自動で読み込みます。 そのため、本リポジトリをローカルに clone していなくても使える curl 導入方式 を最初におすすめします。

✅ curl で既存プロジェクトに導入（推奨）

対象プロジェクトのルートで以下を実行すると、.github/copilot-instructions.md が自動で配置されます。 ローカルに本リポジトリが無くても動作します。

curl -fsSL https://raw.githubusercontent.com/sanpicule/github-copilot-config/main/install.sh | bash

既存ファイルがある場合は対話で上書き確認し、.bak.YYYYMMDDHHMMSS のバックアップを作成します。

オプション（環境変数で上書き可能）:

変数	説明	デフォルト
REPO_BRANCH	取得元ブランチ	main
TARGET_DIR	導入先ディレクトリ	カレントディレクトリ
FORCE	1 で確認なしに上書き	0

例: 確認なしで強制導入する場合

curl -fsSL https://raw.githubusercontent.com/sanpicule/github-copilot-config/main/install.sh | FORCE=1 bash

VS Code を利用している場合は、加えて以下を settings.json に設定しておくと、プロジェクト内の .github/copilot-instructions.md が自動で読み込まれます。

{
  "github.copilot.chat.codeGeneration.useInstructionFiles": true
}

---

その他の導入方法

以下はローカルに本リポジトリを git clone している場合のみ使える方法です。

VS Code の settings.json に絶対パスで指定する

⚠️ この方法は本リポジトリがローカルに存在していることが前提です。"file" はローカル絶対パスしか受け付けないため、事前に以下のように clone しておいてください。

git clone https://github.com/sanpicule/github-copilot-config.git ~/github-copilot-config

Cmd+Shift+P → Open User Settings (JSON) を開き、以下を追記します。

{
  "github.copilot.chat.codeGeneration.instructions": [
    {
      "file": "/Users/<username>/github-copilot-config/.github/copilot-instructions.md"
    }
  ]
}

メリット: 本リポジトリを git pull するだけで全プロジェクトの指示内容が即時更新されます。

シンボリックリンクを貼る（ローカルファイルと常に同期したい場合）

# 対象プロジェクトのルートで実行
mkdir -p .github
ln -s /Users/<username>/github-copilot-config/.github/copilot-instructions.md \
  .github/copilot-instructions.md

shell 関数を使う（新規プロジェクト作成時に自動適用）

~/.zshrc を開いて末尾に以下の関数を追記します。

# 編集コマンド
nano ~/.zshrc
# または
code ~/.zshrc

追記する内容：

function newproject() {
  mkdir -p "$1/.github"
  cp /Users/<username>/github-copilot-config/.github/copilot-instructions.md "$1/.github/"
  cd "$1"
}

保存後、以下のコマンドで設定を反映します。

source ~/.zshrc

使い方：

newproject my-app
# → ~/my-app/.github/copilot-instructions.md が自動作成される

---

instructions の内容

セクション	概要
基本方針	日本語でのやりとり、プランニング優先、語尾は「ござる」
コーディングスタイル	インデント・命名規則・型安全・ドキュメント管理
ファイル・ディレクトリ構成	機能単位の分割、1ファイル1責務
コミットメッセージ	Conventional Commits に準拠
テスト方針	原則テストあり、外部依存はモック
セキュリティ	シークレットは環境変数、入力のバリデーション
その他	可読性優先、エラーハンドリング徹底