Skip to content

docs: add AGENTS.md and CLAUDE.md agent guide - #78

Merged
ykzts merged 2 commits into
mainfrom
docs/add-agents-guide
Sep 1, 2026
Merged

ykzts merged 2 commits into
mainfrom
docs/add-agents-guide

Conversation

@ykzts

@ykzts ykzts commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

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.md describing them, following the guides in the other Publira repositories, and a CLAUDE.md that imports it with @AGENTS.md as publira/comic-viewer, publira/base-images, and publira/publira do.

Changes

  • Add AGENTS.md covering the repository layout, response and documentation language, Conventional Commits with the Assisted-by trailer, pull request rules, Go API and error conventions, test placement, verification commands, and the pinning rules for CI tooling.
  • Add CLAUDE.md containing @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:

gofmt -l .
go vet ./...
golangci-lint run
go test ./...

Checklist

  • I used a Conventional Commits style PR title.
  • I tested my changes locally.
  • I updated docs if needed.

Assisted-by: Claude Code:claude-opus-5

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
@ykzts

ykzts commented Sep 1, 2026

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Sep 1, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai

coderabbitai Bot commented Sep 1, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Added AGENTS.md with repository structure, contribution, Go, testing, verification, EPUBCheck, CI, and tooling guidance. Updated CLAUDE.md to reference AGENTS.md. No exported or public entities changed.

Merge Risk: 🔵 Low · up to 05f75

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)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the addition of AGENTS.md and CLAUDE.md agent guides.
Description check ✅ Passed The description accurately explains the documentation-only changes and their purpose.
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…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
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.)


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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Essentials

Run ID: 0168a0a8-963e-45da-85ec-3bc6cd4366f5

📥 Commits

Reviewing files that changed from the base of the PR and between f84ed87 and 05f75f3.

📒 Files selected for processing (2)
  • AGENTS.md
  • CLAUDE.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.

Comment thread AGENTS.md Outdated
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
@ykzts
ykzts enabled auto-merge (squash) September 1, 2026 14:27
@ykzts

ykzts commented Sep 1, 2026

Copy link
Copy Markdown
Contributor Author

@coderabbitai approve

@coderabbitai

coderabbitai Bot commented Sep 1, 2026

Copy link
Copy Markdown
✅ Action performed

Comments resolved and changes approved.

@ykzts
ykzts merged commit a18d040 into main Sep 1, 2026
3 checks passed
@ykzts
ykzts deleted the docs/add-agents-guide branch September 1, 2026 14:28
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