Skip to content

docs: add AGENTS.md with agent instructions #168 - #169

Open
mart-sessman wants to merge 1 commit into
rcfrom
docs/168-agents-md
Open

mart-sessman wants to merge 1 commit into
rcfrom
docs/168-agents-md

Conversation

@mart-sessman

@mart-sessman mart-sessman commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

Closes #168

Docs only, no release.

Summary by CodeRabbit

  • Documentation
    • Added guidance covering project setup, development commands, source structure, styling, compatibility, and release practices.

@coderabbitai

coderabbitai Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 76c70065-b135-42e8-ab6f-98403412acef
📥 Commits

Reviewing files that changed from the base of the PR and between 26067cd and b3b72ad.

📒 Files selected for processing: 2
  • AGENTS.md
  • CLAUDE.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

📝 Walkthrough

The pull request adds repository guidance in AGENTS.md and updates CLAUDE.md to reference it.

Changes: Repository agent guidance

Layer / File(s) Summary
Add and link repository instructions
AGENTS.md, CLAUDE.md
AGENTS.md describes the package, commands, generated files, build outputs, styling, consumer compatibility, and commit and release requirements. CLAUDE.md now references AGENTS.md.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~4 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to b3b72

This changes contributor guidance only; the documented workflows are supported by repository configuration, and Claude Code loads the shared instructions. No production behavior changes or actionable merge risk are established.

### Architecture Summary

Architecture risk: 🔵 Low · up to b3b72

The change affects 2 systems.

Changed systems: AGENTS.md, CLAUDE.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — AGENTS.md (service) was modified; 1 changed file maps to changed impact.
  • observed — CLAUDE.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in AGENTS.md: Added repository instructions describing the package and its structure, build and lint commands, generated-file ownership, build outputs, styling and consumer compatibility rules, and commit and release requirements.
  • observed — Modified behavior in CLAUDE.md: Added an @AGENTS.md reference to CLAUDE.md.
Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly identifies the documentation change by naming AGENTS.md and its purpose. It matches the main change in the pull request.
Linked Issues check Passed Issue #168 requires AGENTS.md project guidance, commands, token/SCSS structure, build output, release flow, consumer impact, and a one-line CLAUDE.md import. AGENTS.md contains each required top…
Out of Scope Changes check Passed The whole-PR diff adds only AGENTS.md and CLAUDE.md. Both files directly implement issue #168. The changes do not modify source code, generated output, dependencies, or release files.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Full details: Linked Issues check

Explanation

Issue #168 requires AGENTS.md project guidance, commands, token/SCSS structure, build output, release flow, consumer impact, and a one-line CLAUDE.md import. AGENTS.md contains each required topic, including React and Angular consumer impact. CLAUDE.md contains exactly @AGENTS.md. No additional coding or automated-test requirement applies to this documentation issue.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

Comment @coderabbitai help to get the list of available commands.

This branch has not been deployed

No deployments
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.

Add AGENTS.md

1 participant