docs: add AGENTS.md and CLAUDE.md agent guide - #78
Conversation
Document the conventions agents need in this repository: package layout, response and documentation language, Conventional Commits with the Assisted-by trailer, Go API and error conventions, test placement, the verification commands that mirror CI, and the pinning rules for CI tooling. CLAUDE.md imports the guide with @AGENTS.md, matching the other Publira repositories. Assisted-by: Claude Code:claude-opus-5
|
@coderabbitai review |
✅ Action performedReview finished.
|
📝 WalkthroughWalkthroughAdded Merge Risk: 🔵 Low · up to The change only adds contributor documentation, but one example command can fail when copied because its image placeholder is interpreted as shell redirection. The PR is otherwise mergeable with owner follow-up to replace the placeholder with valid example paths. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Docstring CoverageExplanation 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.) Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Essentials
Run ID: 0168a0a8-963e-45da-85ec-3bc6cd4366f5
📒 Files selected for processing (2)
AGENTS.mdCLAUDE.md
Included review availability: 0 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 2 reviews per hour.
In a shell code block, <images...> is parsed as input redirection, so the command fails when copied verbatim. Assisted-by: Claude Code:claude-opus-5
|
@coderabbitai approve |
✅ Action performedComments resolved and changes approved. |
Summary
This repository had no agent guide, so conventions that are only visible in the existing code and CI configuration had to be rediscovered on every session. This PR adds an
AGENTS.mddescribing them, following the guides in the other Publira repositories, and aCLAUDE.mdthat imports it with@AGENTS.mdaspublira/comic-viewer,publira/base-images, andpublira/publirado.Changes
AGENTS.mdcovering the repository layout, response and documentation language, Conventional Commits with theAssisted-bytrailer, pull request rules, Go API and error conventions, test placement, verification commands, and the pinning rules for CI tooling.CLAUDE.mdcontaining@AGENTS.md.How to Test
Documentation only; no code or build configuration is touched. The verification commands the guide documents still pass on this branch:
Checklist
Assisted-by: Claude Code:claude-opus-5