11 lines
766 B
Markdown
11 lines
766 B
Markdown
|
# AGENTS.md
|
||
|
|
|
||
|
|
## Repository Guidance
|
||
|
|
|
||
|
|
- Refrain from commenting on current changes in README files unless the user explicitly asks for that commentary.
|
||
|
|
- Treat clean API surface as a core project priority.
|
||
|
|
- Favor developer ergonomics in public APIs, examples, naming, defaults, and documentation.
|
||
|
|
- Prefer interfaces and behaviors that are predictable, easy to discover, and easy to integrate correctly.
|
||
|
|
- Keep public abstractions small and coherent; avoid exposing internal workflow complexity through the API when it can be encapsulated.
|
||
|
|
- When adding documentation or examples, optimize for practical usage by downstream developers.
|
||
|
|
- When proposing or implementing changes, consider how they affect usability, readability, and maintenance for library consumers.
|