Skip to content

docs: add AGENTS.md and CLAUDE.md#36

Open
Alex-Arsys wants to merge 1 commit into
mainfrom
docs/add-claude-md
Open

docs: add AGENTS.md and CLAUDE.md#36
Alex-Arsys wants to merge 1 commit into
mainfrom
docs/add-claude-md

Conversation

@Alex-Arsys

Copy link
Copy Markdown

AGENTS.md is the canonical guidance file for AI agents working in this repository — covering architecture constraints, conventions, and rules. CLAUDE.md contains only @AGENTS.md, making Claude Code load this file automatically alongside other AI tools.

Assisted-by: ClaudeCode:claude-sonnet-4-6

@Alex-Arsys Alex-Arsys self-assigned this Jun 25, 2026

@chrip chrip left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It just needs a few minor improvements.

Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
- **Packaging:** Uses `pkg`. Adding native modules (`.node`) requires updating `pkg` config.

## Rules
- **Never** modify `SpellChecker/` (pre-compiled binary).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It isn't a pre-compiled binary. JS sources are in SpellChecker/sources.

@chrip chrip left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The AGENTS.md is a useful concept and mostly correct. Two factual errors need fixing:

  1. SpellChecker is source code, not a pre-compiled binary. SpellChecker/sources/server.js, spellCheck.js, languages.js are all Node.js source files. The rule should not call it a "pre-compiled binary."

  2. Issue #51 does not exist. GET /issues/51 returns 404. Either create the issue first, or remove the reference.

The rest of the guidance (async patterns, storage abstraction, schema backends, pkg config) is correct and verified against the codebase.

Comment thread AGENTS.md Outdated
Comment thread AGENTS.md
@chrip

chrip commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Sorry for the duplicate. I posted the first two comments manually. Then, somewhere along the line, a sub-agent finished up and decided on its own to post the same review again. At least we seem to agree :)

AGENTS.md is the canonical guidance file for AI agents working in this
repository — covering architecture constraints, conventions, and rules.
CLAUDE.md contains only `@AGENTS.md`, making Claude Code load this file
automatically alongside other AI tools.

Assisted-by: ClaudeCode:claude-sonnet-4-6
Signed-off-by: Alex Hernández <ahmartin@arsys.es>
@Alex-Arsys Alex-Arsys force-pushed the docs/add-claude-md branch from 28a85b2 to 7a4fbcb Compare June 29, 2026 15:01
@chrip chrip self-requested a review June 29, 2026 15:51

@chrip chrip left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both issues from my last pass are fixed. Looks good.

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.

2 participants