docs: add CLAUDE.md guidance for AI-assisted development - #196
Merged
Conversation
|
No CLAUDE.md previously existed in this repo. Adds project overview, layout, commands, testing conventions, changesets-based release process, commit message format, PR guidelines, and code style notes (self-documenting code, brief why-only comments) so AI coding assistants can work effectively in this repo without re-deriving context each session.
castastrophe
force-pushed
the
cl/review-claude-md-guidelines-2fa70e
branch
from
July 17, 2026 19:55
ae6c33b to
6864135
Compare
castastrophe
commented
Jul 17, 2026
Co-authored-by: [ Cassondra ] <castastrophe@users.noreply.github.com> Signed-off-by: [ Cassondra ] <castastrophe@users.noreply.github.com>
Contributor
|
castastrophe
added a commit
that referenced
this pull request
Aug 14, 2026
Signed-off-by: [ Cassondra ] <castastrophe@users.noreply.github.com>
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.
Summary
CLAUDE.mdpreviously existed in this repo (checked this branch,main, andorigin/main) — this adds one from scratch, grounded in the actual project structure and tooling.postcssas a peer dependency), file layout, common commands, the fixture/expected test convention used intest.js, the Changesets-based release process, Conventional Commits format, PR guidelines pulled from.github/CONTRIBUTING.md, and a code-style note on keeping code self-documenting with brief why-only comments.Test plan
yarn lintpasses (fixed a markdown fenced-code-block missing a language tag, caught by the pre-commit hook)yarn testpasses (5/5, via the pre-commit hook)package.json,index.js,test.js,.changeset/config.json, and.github/CONTRIBUTING.md