FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs: replace copilot-instructions.md with AGENTS.md by hexbinoct · Pull Request #69 · nodejs/node-api-cts · GitHub

docs: replace copilot-instructions.md with AGENTS.md - #69

Merged
legendecas merged 2 commits into
nodejs:mainfrom
hexbinoct:hexbinoct/agents-md
Aug 7, 2026
Merged

docs: replace copilot-instructions.md with AGENTS.md#69
legendecas merged 2 commits into
nodejs:mainfrom
hexbinoct:hexbinoct/agents-md

Conversation

Copy link
Copy Markdown
Contributor

Closes #13.

Moves .github/copilot-instructions.md to AGENTS.md at the root, per
https://agents.md. Git records it as a rename, so the sentence about
'use strict' that #64 added comes along with it. This is the follow-up
I offered there.

Two changes to the content itself.

The porting bullet points at tests/engine/ and tests/runtime/. Those
became tests/js-native-api/ and tests/node-api/ before the first test
landed, so an agent following the file today writes into directories the
runner never reads.

I also added a section with the build and test commands. Nothing in the
repository currently records that the addons need CMake and a C/C++
toolchain on the PATH before npm run node:test can do anything, which
is the first thing anyone new to the repo, human or otherwise, runs into.
The five commands in that block are the ones I ran verbatim, in that
order, on a clean checkout in a Debian container, so the section is
tested rather than recalled. Happy to drop it if you would rather keep
the file to principles only.

Claude Opus 5 drafted this; I reviewed it.

Moves the instructions to the root as AGENTS.md, per agents.md.

Two changes to the content itself:

The porting bullet pointed at `tests/engine/` and `tests/runtime/`, which
were renamed to `tests/js-native-api/` and `tests/node-api/` before the
first test landed. An agent following it today creates directories the
runner never looks in.

Adds a section with the build and test commands, since nothing in the
repository records that the addons need CMake and a C/C++ toolchain before
the suite can run.

Fixes: nodejs#13

Signed-off-by: hexbinoct <abubakarm@gmail.com>
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
legendecas merged commit 805c58a into nodejs:main Aug 7, 2026
13 checks passed
github-project-automation Bot moved this from Need Triage to Done in Node-API Team Project Aug 7, 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

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

Use AGENTS.md instead of copilot-instructions.md

2 participants


Back | FazBrowse Home | New Git URL