Skip to content

Commit cf593fd

Browse files
committed
docs: rename AGENT.md to AGENTS.md and update references
Rename AGENT.md to AGENTS.md as AGENTS.md is now the standard. Update all internal references within the renamed file and cross-references in README.md to maintain documentation integrity. Signed-off-by: Alejandro Mery <amery@apptly.co>
1 parent 7dfc11b commit cf593fd

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

AGENT.md renamed to AGENTS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# AGENT.md
1+
# AGENTS.md
22
<!-- cspell:ignore linters -->
33

44
This file provides guidance to AI agents when working with code in this
@@ -376,7 +376,7 @@ When editing Markdown files, ensure compliance with:
376376
When creating or editing documentation files:
377377

378378
1. **File Structure**:
379-
- Always include a link to related documentation (e.g., AGENT.md should
379+
- Always include a link to related documentation (e.g., AGENTS.md should
380380
link to README.md).
381381
- Add prerequisites or setup instructions before diving into commands.
382382
- Include paths to configuration files when mentioning tools (e.g.,
@@ -406,7 +406,7 @@ When creating or editing documentation files:
406406
- If `make tidy` fails, fix the issues and run it again until it passes
407407
2. Verify all tests pass with `make test`.
408408
3. Ensure no linting violations remain.
409-
4. Update `AGENT.md` to reflect any changes in development workflow or
409+
4. Update `AGENTS.md` to reflect any changes in development workflow or
410410
standards.
411411
5. Update `README.md` to reflect significant changes in functionality or API.
412412

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -651,7 +651,7 @@ Context-aware error group with cancellation:
651651

652652
For detailed development setup, build commands, and AI agent guidance:
653653

654-
* [AGENT.md](./AGENT.md) - Development guidelines, build system, and testing
654+
* [AGENTS.md](./AGENTS.md) - Development guidelines, build system, and testing
655655
patterns.
656656

657657
### Quick Start

0 commit comments

Comments
 (0)