Skip to content

Add AGENTS.md and CLAUDE.md for coding agents - #9

Merged
mabidakun merged 1 commit into
mainfrom
chore/agent-config
Oct 24, 2026
Merged

mabidakun merged 1 commit into
mainfrom
chore/agent-config

Conversation

@mabidakun

Copy link
Copy Markdown
Owner

What does this PR do?

  • Problem: the repo has no guidance for coding agents. An agent must find the commands, the architecture and the rules that the 3.0.0 fixes depend on by reading all the code. For example, search, removal and node freeing must stay iterative, and StringLoader must not go back to Bundle(for:).
  • This PR: adds AGENTS.md with the build, test and lint commands as CI runs them, a short architecture overview and the repo conventions. It also adds a CLAUDE.md that imports AGENTS.md, so Claude Code reads the same file as other agents.
  • Risk: none for library users. The PR adds only these two Markdown files and changes no code, package files or podspec.

Test Evidence

Checked locally on c843827:

Check Command Result
Markdown lint npx markdownlint-cli@0.49.1 AGENTS.md CLAUDE.md no issues
Files changed git diff --stat origin/main HEAD AGENTS.md, CLAUDE.md only

Each file and symbol that AGENTS.md names exists on main at 1cb4ac7, for example normalized(), normalizedPrefix(), wordMap, StringDictionaryType and the CI runner macos-26 with Xcode 26.6.

Background

  • Merge order: this PR, then a small follow-up PR for the README, the podspec and the CI branch name (master is now main).
  • After these merge: tag 3.0.0, create the GitHub release, and run pod trunk push by 2026-10-31.

@mabidakun
mabidakun merged commit 0c905cb into main Oct 24, 2026
1 check passed
@mabidakun
mabidakun deleted the chore/agent-config branch October 24, 2026 10:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant