Repository navigation
docs(NODE-7685): add AGENTS.md file - #128
Merged
Merged
Conversation
johnmtll
marked this pull request as ready for review
July 27, 2026 23:13
johnmtll
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
Adds AI-agent guidance to the repository following agentskills.io conventions, establishing AGENTS.md as the canonical instruction source and wiring up companion tooling/docs to keep tool-specific references in sync.
Changes:
- Add root
AGENTS.mdand a rootCLAUDE.mdthat imports it. - Introduce
scripts/symlink-claude-md.shto generate/cleanupCLAUDE.mdcompanions for stagedAGENTS.mdfiles and to sync.claude/skillsto.agents/skills. - Document the convention and workflow in
README.mdand scaffold.agents/skills/.
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/symlink-claude-md.sh | Adds a sync script for CLAUDE.md references and .claude/skills symlink management. |
| README.md | Documents the AI agent configuration approach and how to add nested AGENTS.md. |
| CLAUDE.md | Adds a tool-specific import reference to AGENTS.md. |
| AGENTS.md | Adds canonical AI coding agent instructions and project conventions/context. |
| .agents/skills/.gitkeep | Creates the skills directory scaffold for future shared skills. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
tadjik1
added
the
Primary Review
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.
Description
Summary of Changes
Adds an AGENTS.md file to the project root, giving key context to ai coding agents on session creation. Conforms with agentskills.io. Features a sync script to support nested AGENTS.md files. Scaffolds the directory for shared skills.
Notes for Reviewers
What is the motivation for this change?
Release Highlight
Release notes highlight
Double check the following
npm run check:lint)type(NODE-xxxx)[!]: descriptionfeat(NODE-1234)!: rewriting everything in coffeescript