chore: add CLAUDE.md and Copilot code review instructions#1500
Draft
nameless-mc wants to merge 2 commits into
Draft
chore: add CLAUDE.md and Copilot code review instructions#1500nameless-mc wants to merge 2 commits into
nameless-mc wants to merge 2 commits into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds repo-wide AI agent guidance files so Claude has implementation context (CLAUDE.md) and GitHub Copilot has consistent PR review instructions (repo-wide + path-scoped rules), with Claude loaders that import the canonical Copilot rules to avoid duplication.
Changes:
- Added root
CLAUDE.mddescribing repository layout, toolchain, commands, testing policy, and cross-repo dependencies. - Added GitHub Copilot review instructions (
.github/copilot-instructions.md) plus path-scoped rule files for TypeScript and tests. - Added
.claude/rules/*.mdloader files that scope and import the matching Copilot instruction files.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| CLAUDE.md | Adds root-level implementation context (layout/tooling/commands/testing policy) and links to AI instruction files. |
| .github/instructions/typescript.instructions.md | Adds TypeScript-specific PR review rules for src/**/*.ts. |
| .github/instructions/tests.instructions.md | Adds test review rules intended for vitest + Cucumber paths. |
| .github/copilot-instructions.md | Adds repo-wide Copilot PR review priorities (correctness/security/tests/review style). |
| .claude/rules/typescript.md | Claude loader importing the canonical Copilot TypeScript rules for src/**/*.ts. |
| .claude/rules/tests.md | Claude loader importing the canonical Copilot test rules for tests/features paths. |
| .claude/rules/repo-wide.md | Claude loader importing the canonical repo-wide Copilot rules. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+1
to
+3
| --- | ||
| applyTo: "src/**/__tests__/**,features/**" | ||
| --- |
Comment on lines
+34
to
+35
| - Node `>=20` (`mise.toml` pins Node 24 for development) | ||
| - Package manager: **pnpm** (`packageManager: pnpm@10.30.3`). |
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.
Why
The repository root has no
CLAUDE.md(onlywebsite/CLAUDE.md, which is scoped to the Docusaurus docs), and there are no GitHub Copilot code review instructions. This PR adds AI agent files with a clear role split:CLAUDE.md.github/copilot-instructions.mdand path-scoped.github/instructions/*.instructions.mdWhat
CLAUDE.md— implementation context for Claude (layout, toolchain, commands, testing policy, cross-repo dependencies).github/copilot-instructions.md— repo-wide Copilot review rules (correctness / security / code quality / tests / review style).github/instructions/typescript.instructions.md— TypeScript review rules (applyTo: "src/**/*.ts").github/instructions/tests.instructions.md— vitest / Cucumber review rules (applyTo: "src/**/__tests__/**,features/**").claude/rules/*.md— Claude-side loaders that@importthe matching Copilot file withpaths:frontmatter, so Claude applies the same rules during implementation without duplicating content. The files under.github/are the canonical source.How to test
pnpm lint:prettierpasses.wc -m):copilot-instructions.md3,117 /typescript.instructions.md2,675 /tests.instructions.md2,347.Checklist
pnpm lintandpnpm teston the root directory.