Skip to content

docs: add CLAUDE.md for Claude Code guidance#30

Merged
LeoFalco merged 1 commit into
masterfrom
docs/add-claude-md
Jul 20, 2026
Merged

docs: add CLAUDE.md for Claude Code guidance#30
LeoFalco merged 1 commit into
masterfrom
docs/add-claude-md

Conversation

@LeoFalco

Copy link
Copy Markdown
Collaborator

Summary

Adds a root CLAUDE.md to guide Claude Code (and human contributors) when working in this repo.

This is a docs-companion repository — every script is a self-contained, runnable demo of one Amonamarth API call, not application code — and that shape isn't obvious from a file listing. The guide captures:

  • What the repo is: runnable examples for the Amonamarth public REST API; no build and no test runner — scripts self-verify with node:assert, so running a script is its test.
  • Commands: nvm use (Node v16), npm install, node <path> to run an example, npm run lint:fix. CI runs super-linter on PRs to master.
  • Auth: .env with API_KEY, sent as x-api-key via core/client.js.
  • core/ internals: the axios client logs requests/responses, parses XML, and uses validateStatus: () => true (non-2xx doesn't throw); utils.js unwrappers getData / getItems / getFistItem.
  • The three-language mirror (pt / en / es) and the rule to keep them in sync, translating only comments and strings.
  • The shared script skeleton and StandardJS style every example follows.

Notes

  • Docs-only change; no source or dependency changes.
  • No PR template exists in this repo.

@LeoFalco
LeoFalco requested a review from a team as a code owner July 20, 2026 18:04
@LeoFalco LeoFalco self-assigned this Jul 20, 2026
@LeoFalco
LeoFalco force-pushed the docs/add-claude-md branch from e8fb47b to 7050ca6 Compare July 20, 2026 18:08
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XNT6qdw2UgQUY9xHp9t1Wc
@LeoFalco
LeoFalco force-pushed the docs/add-claude-md branch from 7050ca6 to bfa767d Compare July 20, 2026 18:09
@LeoFalco
LeoFalco merged commit b4d9103 into master Jul 20, 2026
5 checks passed
@LeoFalco
LeoFalco deleted the docs/add-claude-md branch July 20, 2026 18:13
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