close
Skip to content

meta: add minimal AGENTS.md - #65463

Open
BethGriggs wants to merge 1 commit into
nodejs:mainfrom
BethGriggs:add-basic-agents-md
Open

meta: add minimal AGENTS.md#65463
BethGriggs wants to merge 1 commit into
nodejs:mainfrom
BethGriggs:add-basic-agents-md

Conversation

@BethGriggs

Copy link
Copy Markdown
Member

Now that the project’s AI use guidelines have landed (#62105), which permit the use of such tools, this proposes adding an AGENTS.md file to direct coding agents to the existing policies before they make changes.

Some tools may already discover and follow these documents, but this should make that behaviour slightly more deterministic. If it proves useful then we could consider extending with further instructions.

One consideration is that AGENTS.md is currently ignored (#62612). So, some contributors may have their own file which would subsequently conflict.

I know opinions vary, but the intent here is not to encourage usage of AI tools further than #62105, but to take the opportunity to guide the output.

@nodejs-github-bot nodejs-github-bot added build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project. needs-ci PRs that need a full CI run. tools Issues and PRs related to the tools directory. labels Aug 21, 2026
Adds a minimal AGENTS.md and removes the file from various ignore
lists. The initial file merely points to existing documentation and
guidelines.

Signed-off-by: Beth Griggs <bethanyngriggs@gmail.com>
@BethGriggs
BethGriggs force-pushed the add-basic-agents-md branch from 8b3733e to 9e5a6ae Compare August 21, 2026 17:32
@codecov

codecov Bot commented Aug 21, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.13%. Comparing base (21f0f27) to head (9e5a6ae).
⚠️ Report is 12 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #65463      +/-   ##
==========================================
+ Coverage   90.12%   90.13%   +0.01%     
==========================================
  Files         752      751       -1     
  Lines      252315   252298      -17     
  Branches    47444    47437       -7     
==========================================
+ Hits       227395   227411      +16     
+ Misses      16217    16200      -17     
+ Partials     8703     8687      -16     

see 32 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@bmuenzenmeyer bmuenzenmeyer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm tempted to adopt the convention of suggesting a CLAUDE.md that only states @AGENTS.md per many community workarounds - but I like more that we support the open standard only instead of supporting proprietary formats.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project. needs-ci PRs that need a full CI run. tools Issues and PRs related to the tools directory.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants