📝 AI向け指示文書の監査結果を反映#286
Merged
Merged
Conversation
- context.md に Git 安全ルールを追加（amend+force-push 禁止 / 通常マージのみ / lockfile 更新必須 / pnpm 10.12.4 固定）→ AGENTS.md・Copilot・Cursor へ同期 - sync-ai-instructions.sh に new-component.md の Cursor 向け生成を追加（.cursor/rules/new-component.mdc の欠落を解消） - ai-instructions/README.md から生成されない .github/copilot-instructions.md の行を削除 - change-sparkle-config: 未導入時の誘導に internal 環境向けの install-sparkle-design を併記 - add-sparkle-component: Node.js 18+ は利用側プロジェクトの要件である旨を明記 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012pfrFvQwXGi3DNG7er73Q7
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Walkthrough複数のAI指示ドキュメント（AGENTS.md、.cursor/rules/context.mdc、GitHub instructions、docs/ai-instructions/context.md）にGit Safety Rulesセクションを追加し、新規Cursorルール new-component.mdc を追加、同期スクリプトへ生成分岐を追加、スキルSKILL.mdの導入案内文言とREADME記載を更新した。 ChangesGitセーフティルールの追加
新規コンポーネント作成ルールの追加
スキル案内文言とREADME更新
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Pull request overview
AI 向け指示文書・スキル監査の指摘を sparkle-design に反映し、各ツール（GitHub Copilot / Cursor / Codex / Claude Code）へ同期される生成物の欠落や誤記を解消する PR です。
Changes:
context.mdに Git 運用の安全ルール（force-push禁止、通常マージのみ、lockfile更新、Node/pnpm固定）を追記し、生成物（AGENTS.md / Copilot / Cursor）にも反映sync-ai-instructions.shで Cursor 向けにnew-componentルール生成を追加し、Cursor 側の欠落を解消- AI instructions README の誤記を修正し、Claude スキル文書の誘導文言を改善
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/sync-ai-instructions.sh | Cursor へ new-component ルールを生成する処理を追加 |
| docs/ai-instructions/README.md | 生成されない Copilot 指示ファイルの記載を削除 |
| docs/ai-instructions/context.md | Git Safety Rules とツールチェーン固定情報を追記（指示ソース） |
| AGENTS.md | context.md 由来の Git Safety Rules を反映（生成物） |
| .github/instructions/ai-context.instructions.md | context.md 由来の Git Safety Rules を反映（生成物） |
| .cursor/rules/new-component.mdc | new-component.md を Cursor ルールとして追加（生成物） |
| .cursor/rules/context.mdc | context.md 由来の Git Safety Rules を反映（生成物） |
| .claude/skills/change-sparkle-config/SKILL.md | 未導入時の誘導先として internal 用スキルも併記 |
| .claude/skills/add-sparkle-component/SKILL.md | Node.js 要件の注記を明確化（利用側=18+ / 開発側=22.14.0） |
| ### Git Safety Rules | ||
| - **Never amend + force-push**: address review feedback and mistakes with new commits | ||
| - **No direct push to `main`**: always go through a PR (admin merge required) | ||
| - **PR merges use normal merge (`--merge`)**: never squash-merge (squashing loses commits) |
| - **No direct push to `main`**: always go through a PR (admin merge required) | ||
| - **PR merges use normal merge (`--merge`)**: never squash-merge (squashing loses commits) | ||
| - **Update the lockfile whenever `package.json` changes**: CI runs `pnpm install --frozen-lockfile` and will fail otherwise | ||
| - **Use the pinned toolchain**: Node.js 22.14.0 / pnpm 10.12.4 (see `.tool-versions`; newer pnpm majors can rewrite the lockfile) |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
scripts/sync-ai-instructions.sh (1)
57-65: 🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
generate_cursor()のglobsを YAML 文字列として出力してください。
globs: **は YAML として解釈できず、.cursor/rules/new-component.mdcの frontmatter が壊れます。globsをクォートするか、配列形式にしてください。🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@scripts/sync-ai-instructions.sh` around lines 57 - 65, The frontmatter generated by generate_cursor() is writing globs as an unquoted YAML scalar, which breaks parsing for patterns like **. Update the generate_cursor() output in the sync-ai-instructions.sh flow so globs is emitted as a valid YAML string or sequence, and keep the existing description and alwaysApply fields unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@scripts/sync-ai-instructions.sh`:
- Around line 57-65: The frontmatter generated by generate_cursor() is writing
globs as an unquoted YAML scalar, which breaks parsing for patterns like **.
Update the generate_cursor() output in the sync-ai-instructions.sh flow so globs
is emitted as a valid YAML string or sequence, and keep the existing description
and alwaysApply fields unchanged.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 24763705-3252-475f-857d-295ecc218d72
📒 Files selected for processing (9)
.claude/skills/add-sparkle-component/SKILL.md.claude/skills/change-sparkle-config/SKILL.md.cursor/rules/context.mdc.cursor/rules/new-component.mdc.github/instructions/ai-context.instructions.mdAGENTS.mddocs/ai-instructions/README.mddocs/ai-instructions/context.mdscripts/sync-ai-instructions.sh
💤 Files with no reviewable changes (1)
- docs/ai-instructions/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
概要
5リポジトリ横断の AI 向け文書・スキル監査で見つかった sparkle-design 側の改善点を反映します。
変更内容
docs/ai-instructions/context.mdに amend+force-push 禁止・通常マージのみ・lockfile 更新必須・pnpm 10.12.4 固定を追加。ワークスペース外からこのリポジトリ単体でセッションを開いた AI エージェントもルールに到達できるように（生成物 AGENTS.md / Copilot / Cursor へ同期済み）sync-ai-instructions.shにgenerate_cursor呼び出しを追加（Copilot は 5 件生成されるのに Cursor は 4 件だった）.github/copilot-instructions.mdの行を削除change-sparkle-config: 未導入時の誘導にinstall-sparkle-design（internal 環境の対応スキル）を併記add-sparkle-component: Node.js 18+ が利用側プロジェクト要件である旨を明記マージ後のフォローアップ
pnpm sync:public-skillspnpm sync:skills🤖 Generated with Claude Code
https://claude.ai/code/session_012pfrFvQwXGi3DNG7er73Q7