Skip to content

docs: add CLAUDE.md with rain.flare build invariants (#74)#189

Merged
thedavidmeister merged 2 commits into
mainfrom
docs/issue-74-claude-md
Jul 2, 2026
Merged

docs: add CLAUDE.md with rain.flare build invariants (#74)#189
thedavidmeister merged 2 commits into
mainfrom
docs/issue-74-claude-md

Conversation

@thedavidmeister

@thedavidmeister thedavidmeister commented Jun 29, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Adds CLAUDE.md documenting the load-bearing build invariants: which files are generated, how to regenerate them, nix-shell-only tools, soldeer dependency management, and auto-publish on push to main.
  • .soldeerignore already lists CLAUDE.md (line 15), so the file is excluded from soldeer package distribution.

Closes #74

Test plan

  • Docs-only change; no code or artifact impact.
  • CLAUDE.md is in .soldeerignore, so it won't appear in published soldeer packages.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added contributor guidance covering build requirements, regeneration of generated artifacts, dependency installation, and publishing behavior.
  • Chores
    • Included the new documentation file in the project’s existing reuse/license coverage rules.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@thedavidmeister thedavidmeister self-assigned this Jun 29, 2026
@coderabbitai

coderabbitai Bot commented Jun 29, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: e90f70e7-ff46-4cc6-ae7d-bdafc3efc3a3

📥 Commits

Reviewing files that changed from the base of the PR and between cb20d03 and 4dd9264.

📒 Files selected for processing (2)
  • CLAUDE.md
  • REUSE.toml

Walkthrough

Adds a CLAUDE.md file at the repo root documenting build invariants: artifact regeneration steps, required nix develop tooling, Soldeer dependency installation, and automatic publishing on push to main. Updates REUSE.toml to include CLAUDE.md in its annotation paths.

CLAUDE.md and REUSE registration

Layer / File(s) Summary
Build invariants doc
CLAUDE.md, REUSE.toml
CLAUDE.md documents regeneration of committed artifacts (meta/*.rain.meta, src/generated/FlareFtsoWords.pointers.sol), mandatory nix develop tooling, Soldeer install, and auto-publish on main. REUSE.toml adds CLAUDE.md to the annotated paths.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the new CLAUDE.md docs for build invariants.
Linked Issues check ✅ Passed The PR adds the requested root CLAUDE.md with the key build and publish invariants.
Out of Scope Changes check ✅ Passed The only code change beyond the doc file is the related REUSE.toml annotation update.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/issue-74-claude-md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

…tempt]

Co-Authored-By: Claude <noreply@anthropic.com>
@thedavidmeister

Copy link
Copy Markdown
Collaborator Author

human-approved; merging

@thedavidmeister thedavidmeister merged commit e2bf8ed into main Jul 2, 2026
5 checks passed
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.

[F25] [LOW] No CLAUDE.md/AGENTS.md despite repo being part of an agent-driven org workflow with non-obvious build invariants

1 participant