Skip to content

Add AGENTS.md and CLAUDE.md documentation - #581

Merged
gasher merged 3 commits into
masterfrom
chore/add-agents-file
Sep 24, 2026
Merged

gasher merged 3 commits into
masterfrom
chore/add-agents-file

Conversation

@gasher

@gasher gasher commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Adds a root AGENTS.md plus one per substantial package under packages/*/AGENTS.md, following the org's house style (verified against real package.json scripts, .github/workflows/, lerna.json, jest/coverage configs — no invented facts).
  • Adds a root CLAUDE.md (@AGENTS.md).

Test plan

  • Skim the root AGENTS.md and one package doc for accuracy
  • Confirm cited commands/paths still match the repo

🤖 Generated with Claude Code

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@codecov

codecov Bot commented Sep 21, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 60.91%. Comparing base (6ebe997) to head (15817ac).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #581      +/-   ##
==========================================
- Coverage   60.97%   60.91%   -0.07%     
==========================================
  Files         177      177              
  Lines        4915     4915              
  Branches      575      575              
==========================================
- Hits         2997     2994       -3     
- Misses       1845     1848       +3     
  Partials       73       73              
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@mike-parkhill mike-parkhill 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.

lgtm, but would like @maycon-mello's review of this

Copilot AI 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.

Copilot review overview

🟡 Changes recommended

Several documented commands, paths, dependency claims, and test descriptions are inaccurate and need correction.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 6 Low severity

Open (6)
What changed in this PR

Adds repository-wide and package-level contributor guidance, plus a CLAUDE.md reference to the root instructions.

Changes:

  • Documents architecture, workflows, testing, and conventions.
  • Adds guides for WASM, React Native, TypeORM, core, and CLI packages.
  • Adds CLAUDE.md redirecting to AGENTS.md.
File Summary
packages/​wasm/​AGENTS.md WASM build and testing guidance
packages/​react-native/​AGENTS.md React Native bundling and test guidance
packages/​data-store-typeorm/​AGENTS.md TypeORM storage guidance
packages/​core/​AGENTS.md Core package guidance
packages/​cli/​AGENTS.md CLI usage and testing guidance
CLAUDE.md References root agent instructions
AGENTS.md Repository-wide architecture, workflow, testing, and guardrails

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread AGENTS.md
Comment thread AGENTS.md Outdated
Comment thread packages/core/AGENTS.md Outdated
Comment thread packages/react-native/AGENTS.md Outdated
Comment thread packages/react-native/AGENTS.md Outdated
Comment thread packages/wasm/AGENTS.md Outdated
maycon-mello
maycon-mello previously approved these changes Sep 22, 2026
@gasher
gasher merged commit 6ca0321 into master Sep 24, 2026
10 checks passed
@gasher
gasher deleted the chore/add-agents-file branch September 24, 2026 07:05
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.

4 participants