Skip to content

Commit 1d38e7c

Browse files
authored
Updated for AGENTS.md (awslabs#57)
1 parent a4faa5b commit 1d38e7c

2 files changed

Lines changed: 21 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# General Guidance for Agentic Coding Assistants
2+
3+
## Documentation
4+
- When writing documentation, always try to say more with less.
5+
- Documentation should be minimal, and only say what needs to be said to communicate how to work with and extend the system.
6+
7+
## MKDocs Documentation Project
8+
- An MKDocs documentation project exists at [docs/](./docs/). More information can be found in the [docs/README.md](./docs/README.md) and [docs/AGENTS.md](./docs/AGENTS.md) files.
9+
10+
## Testing
11+
- Test documentation and guidelines can be found in [tests/README.md](./tests/README.md).
12+
13+
## README.md
14+
- In addition to MKDocs, The project strives to maintain developer documentation distributed in README.md files throughout the codebase. This documentation exists to help human and AI coding assistants when working with the codebase.
15+
- When creating directories or working in a directory that does not have a README.md create a README.md file and document the final state of the code and logic that's in the directory. Do this in language that an AI coding assistant trying to understand the implementation and codebas would understand.
16+
- When working in a directory, always look for a README.md and/or AGENTS.md file for important context about the directory/code contained within.

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -654,3 +654,8 @@ print(f"Line Items: {result['field_scores']['line_items']:.3f}") # ~1.0 - match
654654
## Examples
655655

656656
Check out the `examples/` directory for more detailed usage examples and notebooks.
657+
658+
# A note for AI assisted coding agents
659+
- The project uses coding assistant agnostic context files, like README.md and AGENTS.md
660+
- When working in a directory, always look for a README.md and/or AGENTS.md file for important context about the directory/code contained within.
661+
- Read this [AGENTS.md](./AGENTS.md) file for more information

0 commit comments

Comments
 (0)