Add AGENTS.md

[acicovic]

Description

With this PR, we're adding an AGENTS.md and an associated CLAUDE.md file.

The file was purposefully kept lean and was manually written, to address LLM mistakes we're seeing often. It will get updated as we go and notice other patterns that need addressing when we resume active work on this project.

Summary by CodeRabbit

• Documentation
  • Added internal development guidelines covering code quality, accessibility standards, testing practices, and documentation requirements.

[coderabbitai]

📝 Walkthrough

Walkthrough

Two new documentation files are added: AGENTS.md establishes global guidelines for LLM behavior, code quality, accessibility standards, testing practices, and documentation conventions; CLAUDE.md contains a reference link to AGENTS.md.

Changes

Cohort / File(s)	Summary
Documentation Guidelines AGENTS.md, CLAUDE.md	New guideline files defining standards for LLM behavior, code quality, accessibility (WCAG 2.2 Level AA), testing practices (preferring assertSame), and documentation conventions. CLAUDE.md references AGENTS.md.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description is incomplete. While it explains what files are being added, it lacks critical sections from the template: motivation/context for why these guidelines are needed, and how the changes were tested.	Add 'Motivation and context' section explaining why LLM guidelines are needed, and 'How has this been tested' section describing validation approach for the guidelines.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Add AGENTS.md' accurately describes the main change in the pull request, which adds a new AGENTS.md file with LLM behavior guidelines.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch add/agents-md

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

🧹 Nitpick comments (1)

AGENTS.md (1)

13-16: Consider adding reference links for external standards.

While the guidelines are clear and accurate, adding hyperlinks would help users unfamiliar with these standards:

• Line 14: Could link to WordPress Inline Documentation Standards
• Line 15: Could link to WCAG 2.2 Level AA

📚 Proposed enhancement with reference links

-- Adhere to WordPress inline documentation standards.
-- For accessibility, adhere to WCAG 2.2 Level AA standards or higher whenever possible.
+- Adhere to [WordPress inline documentation standards](https://developer.wordpress.org/coding-standards/inline-documentation-standards/).
+- For accessibility, adhere to [WCAG 2.2 Level AA](https://www.w3.org/WAI/WCAG22/quickref/?levels=aa) standards or higher whenever possible.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@AGENTS.md` around lines 13 - 16, Update AGENTS.md to include reference links
for the external standards mentioned: add a hyperlink on the phrase "WordPress
inline documentation standards" pointing to
https://developer.wordpress.org/coding-standards/inline-documentation-standards/
and add a hyperlink on "WCAG 2.2 Level AA" pointing to
https://www.w3.org/WAI/WCAG22/quickref/?levels=aa; ensure the linked text
remains exactly as currently written so other references still match and place
the links inline where those phrases appear.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@AGENTS.md`:
- Around line 13-16: Update AGENTS.md to include reference links for the
external standards mentioned: add a hyperlink on the phrase "WordPress inline
documentation standards" pointing to
https://developer.wordpress.org/coding-standards/inline-documentation-standards/
and add a hyperlink on "WCAG 2.2 Level AA" pointing to
https://www.w3.org/WAI/WCAG22/quickref/?levels=aa; ensure the linked text
remains exactly as currently written so other references still match and place
the links inline where those phrases appear.

---

ℹ️ Review info

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d846c81 and 53fcad7.

📒 Files selected for processing (2)

• AGENTS.md
• CLAUDE.md