docs: add CLAUDE.md with project conventions#21
Draft
Koan-Bot wants to merge 1 commit into
Draft
Conversation
Codifies project structure, call flow, testing patterns, and key conventions (Simple::Accessor lowercase accessors, Dist::Zilla build system, example embedding) to help contributors ramp up quickly. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Add a CLAUDE.md file documenting project structure, architecture, testing patterns, and conventions.
Why
After 10+ sessions on this project, the accumulated knowledge about conventions (lowercase accessor names, Dist::Zilla workflow, example embedding, test mock patterns) lives only in session learnings. A CLAUDE.md makes this discoverable for any contributor — human or AI.
How
Single concise file covering: project structure, call flow (
post_*→_notify→notify_slack→_http_post), testing conventions (mock patterns, NoWarnings), build system notes (Dist::Zilla generates Makefile.PL/README), and key gotchas.Testing
No code changes — documentation only. All 48 existing tests pass.
🤖 Generated with Claude Code
Quality Report
Changes: 1 file changed, 68 insertions(+)
Code scan: clean
Tests: passed (OK)
Branch hygiene: clean
Generated by Kōan post-mission quality pipeline