Merged
Conversation
Adds .github/copilot-instructions.md with build/validate commands, project layout, house-style rules, and the rename/move checklist so Copilot (cloud agent, code review, and IDE) produces changes that match what this repo expects and CI enforces.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
anegg0
approved these changes
Apr 24, 2026
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
2 participants
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.
Description
Adds
.github/copilot-instructions.mdso GitHub Copilot (cloud agent, code review, and IDE) has repo-specific context. Without it, Copilot guesses at our conventions and reviewers end up correcting the same issues on every PR.The file encodes what the existing
PR_REVIEW_RUBRIC(derived from 6,852 review comments across 1,181 PRs) flags most often:build.yml,main.yml, andtest.yml.22.xpin,docs/sdk/**is auto-generated.docs/and the standard + glossary frontmatter shapes.:::admonitions (not> [!NOTE]),parent chain/child chainoverL1/L2, Orbit vs. Arbitrum chain distinction, actor distinctions.sidebars.js,vercel.json, internal links,i18n/mirrors).Document type
Checklist
yarn prettier --checkyarn markdownlintdocs/Additional notes
Kept under ~2 pages per GitHub's guidance for Copilot instructions files. The "trust these instructions" closer tells Copilot not to re-explore the repo unless something here is wrong or missing.