AGENTS.md@packages/_example · diff
git:20260504.5d00780 to git:20260819.db5a4ed
13 added, 42 removed. Audit A to A.
- # AGENTS.md (package: `_example`)
-
- > Per-package agent context. The root `AGENTS.md` already covers monorepo-wide
- > conventions — don't repeat them here. Only put things specific to this package.
-
- ## What this package is
-
- <!-- One sentence. Replace this. -->
- This is a placeholder package showing the per-package AGENTS.md pattern.
-
- ## Public surface
-
- <!--
- What does this package export? What's internal vs. external? Be specific
- about what counts as a "public" interface — those are the things changes
- need to be coordinated with consumers.
+ # AGENTS.md — placeholder package
- - Public: everything in `src/index.<ext>`
- - Internal: everything under `src/internal/`
- - Tests: under `tests/`, do not import from any other package's `src/internal/`
- -->
+ Applies to `packages/_example/`. Inherits the root `AGENTS.md`. Scope-specific deltas only.
- ## Constraints particular to this package
+ ## Package identity
- <!--
- Things an agent would otherwise have to discover by reading the code:
+ This placeholder package demonstrates concise package-local instructions. Replace
+ this text with the package's purpose and the users or callers it serves.
- - Targets <runtime> version <X>.
- - Avoids <dependency Y> for <reason>.
- - Performance budget: <metric> under <threshold>.
- - Backward compatibility window: <duration> for the public API.
- -->
+ ## Public boundary
- ## How to test this package
+ State the package's public interface, internal implementation boundary, and any
+ exceptional compatibility or runtime constraint here.
- <!--
- If the test command differs from the monorepo default, document it here.
- Otherwise omit this section.
- -->
+ ## Exceptional verification
- ## When changes here need an ADR
+ Document a test command only when it differs from the monorepo default.
- <!--
- Some packages have heightened sensitivity — auth packages, data layer,
- public SDKs. If this is one of those, list the categories of change that
- trigger an ADR.
+ ## Deeper documentation
- Example:
- - Any change to the wire format requires an ADR.
- - Any new dependency with non-MIT/Apache license requires an ADR.
- -->
+ Put detailed architecture, API, and release rationale in the appropriate package
+ documentation or repository reference; do not turn this file into a manual.