docs(claude.md): add Commands and Footguns sections#60
Open
Chosen9115 wants to merge 1 commit into
Open
Conversation
Surgical additions to align CLAUDE.md with the 7-section convention now shared across all three OpenSOP repos: * Commands — enumerates the 13 commands an agent actually runs (bin/setup, bin/dev, bin/jobs, rspec variants, lint, security scans, deploy). Was previously missing; agents had to infer from the Procfile + bin/. * Footguns — pulls together hazards that were scattered across the existing "Architectural conventions" section (eval discipline, YAML-as-contract, Sop::/Opensop:: split, executor idempotency, seeds idempotency). No content removed. No workflow changes. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.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
Brings CLAUDE.md in line with the 7-section convention shared across the three OpenSOP repos. Two purely-additive sections:
## Commands— the 13 commands an agent runs most (boot, test, lint, security scans, deploy). Was missing; agents had to infer fromProcfile.devandbin/.## Footguns— consolidates hazards that were scattered through the existing Architectural conventions section.No existing content removed or reordered.
Self-rating (7-axis, per this repo's convention)
Improvement applied in polish pass
The first draft of the Footguns section repeated the eval rule from Architectural conventions verbatim; rewrote it to be a sharper one-line statement, with the rationale ("Enforced by code review") trailing.
Test plan
Docs-only. Verify the file renders correctly in the GitHub UI after merge.
🤖 Generated with Claude Code