copilot-rules-kit

集中維護的 AI 助手產出規範套件（for GitHub Copilot / VS Code Agent / 其他 LLM 協作工具）。 目標：在多個專案之間 統一生成規範、術語詞彙、與文件模板，確保產出 正確性、可維護性、與一致性。

適用情境：公司/團隊以 git submodule 或 git subtree 導入本套件至各個專案，並以 tag 版本 管理升級與回滾。

• Repo：https://github.com/vincent119/copilot-rules-kit

🚀 快速開始（Go Copilot Skills）

如果你只需要安裝 Go 開發規範與 Skills（.agent_agy/ 目錄），請使用：

# NPX 一鍵安裝（推薦）
npx @vincent119/go-copilot-rules

# 或使用安裝腳本
bash <(curl -s https://raw.githubusercontent.com/vincent119/copilot-rules-kit/main/scripts/quick-install.sh)

支援的安裝選項：

• --vscode - 安裝到 VS Code Copilot 預設路徑（.agent_agy/）
• --cursor - 安裝到 Cursor 預設路徑（.cursor/skills/）
• --skills "go-ddd,go-grpc" - 只安裝特定 Skills
• --help - 查看所有選項

📖 完整文件：.agent_agy/INSTALLATION.md

內容構成（中央規範倉庫）

copilot-rules-kit/
├── CHANGELOG.md
├── LICENSE
├── README.md
├── copilot-chat-instructions.yaml
├── copilot-instructions.md
├── copilot-instructions.yaml
├── instructions/
│   ├── bash.instructions.md
│   ├── go.instructions.md
│   ├── helm.instructions.md
│   ├── pulumi.instructions.md
│   ├── python.instructions.md
│   ├── ts.instructions.md
│   └── yaml.instructions.md
├── scripts/
│   ├── merge_copilot_instructions.py
│   ├── setup-copilot-submodule.sh
│   ├── setup-copilot-subtree.sh
│   ├── setup-pre-commit.sh
│   └── vocabulary_scan.py
└── standards/
    ├── copilot-commit-message-instructions.md
    ├── copilot-common.md
    ├── copilot-instructions-extended.md
    ├── copilot-pull-request-description-instructions.md
    └── copilot-vocabulary.yaml

消費端導入位置（推薦）

建議導入位置：直接放在 .github/ 目錄下 優點：Copilot 可直接讀取 .github/copilot-instructions.md；與 GitHub 生態一致。

A. 以 Git Submodule 導入（推薦：清楚版本邊界、易回滾）

# 於消費端專案根目錄執行，直接導入到 .github/
git submodule add https://github.com/vincent119/copilot-rules-kit.git .github
git submodule update --init --recursive

#（可選）鎖定到特定版本 tag（例：v1.0.3）
cd .github && git fetch --tags && git checkout v1.0.3 && cd -
git add .gitmodules .github
git commit -m "chore: add [email protected] as submodule"

升版到新 tag：

cd .github
git fetch --tags
git checkout v1.0.4
cd -
git add .github
git commit -m "chore: upgrade copilot-rules-kit to v1.0.4"

CI 注意事項：

# CI 若需存取規範檔，請先同步子模組
git submodule update --init --recursive

B. 以 Git Subtree 導入（倉庫不帶 submodule 依賴）

git subtree add --prefix .github https://github.com/vincent119/copilot-rules-kit.git main --squash

從上游拉取最新（同分支或 tag）：

git subtree pull --prefix .github https://github.com/vincent119/copilot-rules-kit.git main --squash

腳本使用說明（可於消費端直接使用）

1) scripts/setup-copilot-submodule.sh

用途：一鍵將本套件以 submodule 形式導入到消費端的 .github/，並鎖定到指定版本。

用法：

# 預設導入到 .github 並鎖定 v1.0.3
bash scripts/setup-copilot-submodule.sh

# 自訂導入目錄與版本
bash scripts/setup-copilot-submodule.sh .github v1.0.4

行為：

• 新增子模組 → 初始化遞迴 → 抓取 tags → 切換至指定 tag
• 將 .gitmodules 與目標目錄加入版本控制並建立提交

2) scripts/setup-copilot-subtree.sh

用途：一鍵以 subtree 方式導入到 .github/。

用法：

# 導入 main 分支
bash scripts/setup-copilot-subtree.sh

# 指定前置目錄與來源 ref（分支或 tag）
bash scripts/setup-copilot-subtree.sh .github v1.0.3

行為：

• 以 --squash 壓縮上游歷史，保持消費端歷史乾淨

3) scripts/vocabulary_scan.py

用途：依 standards/copilot-vocabulary.yaml 執行術語掃描，提示黑名單或建議用語。

用法：

python3 .github/scripts/vocabulary_scan.py \
  --vocab .github/standards/copilot-vocabulary.yaml \
  --paths "docs/**/*.md" "src/**/*.go" "src/**/*.ts"

輸出：

• 發現黑名單：[DISALLOWED] <詞> in <檔案>
• 提示建議改寫：[SUGGEST] <錯> → <正> in <檔案>---

授權

MIT（詳見 LICENSE）。