docs: replace copilot-instructions.md with AGENTS.md - #69
Merged
Conversation
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
approved these changes
Aug 7, 2026
github-project-automation
Bot
moved this from Need Triage
to Done
in Node-API Team Project
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.
Closes #13.
Moves
.github/copilot-instructions.mdtoAGENTS.mdat the root, perhttps://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-upI offered there.
Two changes to the content itself.
The porting bullet points at
tests/engine/andtests/runtime/. Thosebecame
tests/js-native-api/andtests/node-api/before the first testlanded, 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
PATHbeforenpm run node:testcan do anything, whichis 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.