Agent Guide

[ChengShi-1]

What this PR does / why we need it:

Adds an AGENTS.md at the repo root.

Claude generated the initial draft as a skill, but this markdown is not one skill here. AGENTS.md is read as always-on context for the whole repo, while a skill only loads when its description matches the current task.

Claude said "Broad "here's our whole architecture" content is exactly the kind of thing you want always-on — converting it to a skill risks it getting silently skipped on tasks that don't obviously match the trigger phrase. Skills fit better for narrower, task-shaped guidance (e.g. "how to test against a different js-dataverse PR build" is more skill-shaped than "our layering conventions").
Optionally, splitting AGENTS.md into some small skills (e.g. writing new use case, testing troubleshooting) would be good to shrink the markdown to the core architecture content."

I added notes and questions based on problems I encountered while working with it, including how to handle flaky tests and how to verify API behavior before writing new use cases.

Additional guidance is welcome, especially rules that could reduce hallucinations and improve the agent’s accuracy and overall performance.

A human readable format, link for AGENTS.md: https://github.com/IQSS/dataverse-client-javascript/blob/d90e9b009849a7c8f88543e5ef3905571d55cc1f/AGENTS.md

Which issue(s) this PR closes:

• Closes #

Related Dataverse PRs:

• Depends on #

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.md convention (Cursor, Codex, and others converging on it) load it as ambient context automatically too. Zero prompt needed. Codex or Copilot auto-discovers AGENTS.md at 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

[Copilot]

Pull request overview

Adds a new repository-root AGENTS.md meant to serve as the canonical “agent guide” for AI tools and contributors working in this SDK repo, documenting architecture, HTTP/auth behavior, and testing/CI workflows.

Changes:

• Introduces AGENTS.md describing the SDK’s clean-architecture layering and composition-root pattern.
• Documents HTTP/auth configuration patterns and common “gotchas”.
• Documents test suite structure (unit/integration/functional) and CI workflow expectations.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.