Skip to content

docs(NODE-7685): add AGENTS.md file - #128

Open
johnmtll wants to merge 4 commits into
mainfrom
NODE-7685/add-agents-file
Open

docs(NODE-7685): add AGENTS.md file#128
johnmtll wants to merge 4 commits into
mainfrom
NODE-7685/add-agents-file

Conversation

@johnmtll

@johnmtll johnmtll commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

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

  • Lint is passing (npm run check:lint)
  • Self-review completed using the steps outlined here
  • PR title follows the correct format: type(NODE-xxxx)[!]: description
    • Example: feat(NODE-1234)!: rewriting everything in coffeescript
  • Changes are covered by tests
  • New TODOs have a related JIRA ticket

@johnmtll
johnmtll marked this pull request as ready for review July 27, 2026 23:13
@johnmtll
johnmtll requested a review from a team as a code owner July 27, 2026 23:13
Copilot AI review requested due to automatic review settings July 27, 2026 23:13
@johnmtll johnmtll changed the title docs: add AGENTS.md file docs(NODE-7685): add AGENTS.md file Jul 27, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md and a root CLAUDE.md that imports it.
  • Introduce scripts/symlink-claude-md.sh to generate/cleanup CLAUDE.md companions for staged AGENTS.md files and to sync .claude/skills to .agents/skills.
  • Document the convention and workflow in README.md and 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.

Comment thread scripts/symlink-claude-md.sh
Comment thread scripts/symlink-claude-md.sh
Comment thread README.md
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants