Agent Guide - #474
Draft
ChengShi-1 wants to merge 3 commits into
Draft
Conversation
pdurbin
reviewed
Aug 4, 2026
| @@ -0,0 +1,165 @@ | |||
| # Copilot instructions: dataverse-client-javascript | |||
|
|
|||
| This file is a copy of [AGENTS.md](../AGENTS.md) at the repository root, kept here because this is the path GitHub Copilot reads automatically for repository-wide chat and code-review context. Keep both in sync. | |||
Member
There was a problem hiding this comment.
Please check this out: https://docs.github.com/en/enterprise-cloud@latest/copilot/tutorials/cloud-agent/get-the-best-results#adding-custom-instructions-to-your-repository
Here's a screenshot:
I think this means we can safely delete the .github/copilot-instructions.md file. No syncing! 🎉
p.s. I found those docs via https://github.blog/changelog/2025-08-28-copilot-coding-agent-now-supports-agents-md-custom-instructions/
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.
What this PR does / why we need it:
Adds an
AGENTS.mdat the repo rootA human readable format, link for
AGENTS.md: https://github.com/IQSS/dataverse-client-javascript/blob/d90e9b009849a7c8f88543e5ef3905571d55cc1f/AGENTS.mdWhich issue(s) this PR closes:
Related Dataverse PRs:
Special notes for your reviewer:
GitHub Copilot can read for every chat and PR-review interaction in this repo by design; that's the entire reason that file exists.
Tools that natively support the
AGENTS.mdconvention (Cursor, Codex, and others converging on it) load it as ambient context automatically too. Zero prompt needed. Codex or Copilot auto-discoversAGENTS.mdat the repo root and loads it as instructions for every session in that repo.Suggestions on how to test this:
No functional code changed; this is documentation only.
Is there a release notes or changelog update needed for this change?:
No. This only adds contributor/agent documentation; it doesn't change any use case, public API, or behavior.
Additional documentation:
AGENTS.md