CLAUDE.md: documentation, PR, stacking and review rules - #409
Open
bkontur wants to merge 11 commits into
Open
Conversation
What the PR does and why, follow-ups, open questions. No fluff.
Stack only on a real dependency, each PR still self-contained; never stack unrelated work. Name the base PR in the description; merge bottom-up.
Generated-file conflicts (bindings, metadata, weights) are not a reason to stack, and a stacked PR must say what it stacks on and in which order the stack merges. Descriptions are kept current as the PR changes.
Diff each PR against its own base, check every link is a real dependency, and propose a restructure instead of only flagging it.
Every added or edited doc is simple and to the point: no fluff, no restating the code or the diff, no boilerplate.
bkontur
changed the title
bkontur
changed the title
…e overlapping rules The stacked-PR review rule said "rebase onto dev" while the git rules forbid rebase and force-push; it now says retarget, and the author does any history rewrite. The Claude review bot section described a bot with no workflow behind it; the actual trigger is /aireview. Three overlapping design bullets and two overlapping review bullets are merged. New rules: regenerated files in their own commit, benchmark new extrinsics before review, public APIs need rustdoc moved under documentation.
…e README - skills/test/pallet.md has no SKILL.md so it is never loaded, and its content is wrong: crate names that do not exist (storage-provider-pallet), a /runtime path (runtimes/ now), and tarpaulin where CI uses scripts/coverage.sh. - commands/review-pr.md is a subset of the /review skill, which CLAUDE.md names as the authoritative review criteria. - README.md documented only those two entries and none of the five real skills.
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.
Agent rules in
CLAUDE.md, prompted by the #403–#408 stack: unrelated PRs stacked on each other, descriptions that restated the diffs, and a hand-written weights paragraph shipped for review.New rules
/cmd benchbefore review.Cleanup
/aireviewtrigger..claude/entries: thetestskill (noSKILL.md, wrong crate names and paths), thereview-prcommand (subset of/review), and the README that described only those two.Follow-ups
docs/reference/anddocs/filesystems/rows stay until docs: delete the derived docs that kept drifting from the code #406 deletes those directories.