agents: Add AGENTS.md file

[echarrod]

• Add AGENTS.md file, for multi-agent instructions

Summary by CodeRabbit

• Documentation
  • Introduced comprehensive guidance documentation for developers and AI agents working with the repository, covering project architecture, API design patterns, development setup, testing methodologies, and Git workflow conventions.

[coderabbitai]

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)

• .DS_Store is excluded by !**/.DS_Store

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Two new documentation files were added to guide AI agents working with the Luno Python SDK repository. AGENTS.md provides comprehensive guidance covering project context, architecture overview, request/response flow, API design patterns, development commands, testing approach, Git workflow conventions, code generation notes, and file editing requirements. CLAUDE.md contains Claude Code-specific guidance and directs readers to AGENTS.md. Both additions are purely documentation with no functional code changes or modifications to exported entities.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

These changes consist solely of two new markdown documentation files with no logic, functional code, or structural impact to review. The content is straightforward guidance documentation with consistent formatting throughout both files.

Poem

🐰 Two scrolls of wisdom now unfurl,
To guide the agents through our world!
Instructions clear, paths well-lit,
For Claude and friends to make their bit.
With AGENTS wise and CLAUDE so true,
Our repository guides them through! 🎯

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The pull request title "agents: Add AGENTS.md file" is concise, specific, and directly reflects the primary change in the changeset. The title clearly indicates both the area of change (agents) and the specific action (adding AGENTS.md), which aligns with the main objective of adding documentation for multi-agent instructions. The title accurately summarises the most significant addition without being vague or overly broad, and a teammate reviewing the commit history would immediately understand that this PR introduces new agent guidance documentation.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

---

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]

Actionable comments posted: 0

🧹 Nitpick comments (2)

CLAUDE.md (1)

5-5: Simplify the reference to AGENTS.md.

Line 5 has awkward formatting with the "@AGENTS.md" notation and redundant parenthetical. Consider rephrasing for clarity:

-For compatibility with multiple agents, the instructions are located at @AGENTS.md (see [AGENTS.md](./AGENTS.md).
+For compatibility with multiple agents, see the instructions in [AGENTS.md](./AGENTS.md).

AGENTS.md (1)

3-3: Correct the spelling of GitHub's product name.

Line 3 uses "CoPilot" but GitHub's official product name is "Copilot" (single capital C).

-This file provides guidance to agents (e.g. Claude Code / GitHub CoPilot) when working with code in this repository.
+This file provides guidance to agents (e.g. Claude Code / GitHub Copilot) when working with code in this repository.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1156d88 and 8a324fd.

⛔ Files ignored due to path filters (1)

• .DS_Store is excluded by !**/.DS_Store

📒 Files selected for processing (2)

• AGENTS.md (1 hunks)
• CLAUDE.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

AGENTS.md

[misspelling] ~3-~3: Possible spelling mistake found.
Context: ... guidance to agents (e.g. Claude Code / GitHub CoPilot) when working with code in this reposit...

(EN_MULTITOKEN_SPELLING_TWO)

---

[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...ture - luno_python/base_client.py: Base HTTP client class (BaseClient) t...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~20-~20: Loose punctuation mark.
Context: ...stitution - luno_python/client.py: Main Client class extending `BaseClie...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~26-~26: Loose punctuation mark.
Context: ...dictionary - luno_python/error.py: Custom APIError exception class for h...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~28-~28: Loose punctuation mark.
Context: ... errors - luno_python/__init__.py: Exports package version ### Request/Re...

(UNLIKELY_OPENING_PUNCTUATION)

---

[duplication] ~97-~97: Possible typo: you repeated a word.
Context: ...1. Run git pull before creating a new branch 2. Branch naming: `{username}-{issue-number}-{des...

(ENGLISH_WORD_REPEAT_RULE)

🔇 Additional comments (1)

AGENTS.md (1)

1-113: Excellent documentation resource for agent-based workflows.

This is a well-structured and comprehensive guide covering all essential aspects of working with the Luno Python SDK repository. The sections on architecture, development commands, testing approach, and Git workflow conventions provide clear, actionable guidance. The documentation should significantly improve agent efficiency when working with this codebase.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud