Skip to content

docs: link the Intent Layer AGENTS.md files and global invariants from CLAUDE.md - #7

Merged
satyamshivam13 merged 1 commit into
mainfrom
docs/intent-layer-claude-md
Jul 14, 2026
Merged

docs: link the Intent Layer AGENTS.md files and global invariants from CLAUDE.md#7
satyamshivam13 merged 1 commit into
mainfrom
docs/intent-layer-claude-md

Conversation

@satyamshivam13

@satyamshivam13 satyamshivam13 commented Jul 14, 2026

Copy link
Copy Markdown
Owner

Summary

Adds an Intent Layer section to CLAUDE.md that points contributors at the three AGENTS.md files already tracked in the repo, and records the invariants that cut across them.

  • Directs readers to src/analyzers/AGENTS.md, src/utils/AGENTS.md, and src/models/AGENTS.md before modifying code in those directories.
  • Documents global invariants: the analyze() → AnalysisResult entry point, the get_settings() lru_cache singleton, lazy transformer imports that keep app.py runnable without torch, the Verdict.UNCERTAIN error-handling contract, and the Black/isort/flake8 style config.

Notes

Documentation only — no code changes, no behavior change.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added repository-wide contributor guidance covering analysis workflows, configuration access, threshold handling, lazy loading, application startup, error handling, and code style.
    • Documented a standardized approach for handling analysis failures with uncertain results, zero confidence, and warnings.

…m CLAUDE.md

Points contributors at src/analyzers, src/utils, and src/models AGENTS.md
before they modify code in those directories, and records the invariants
that cut across them (analyze() entry point, settings singleton, lazy
transformer imports, error-handling contract, style config).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@satyamshivam13
satyamshivam13 merged commit ee92187 into main Jul 14, 2026
9 of 10 checks passed
@satyamshivam13
satyamshivam13 deleted the docs/intent-layer-claude-md branch July 14, 2026 10:19
@coderabbitai

coderabbitai Bot commented Jul 14, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 0d46f13d-81f5-4e21-8b0f-ae22885c055b

📥 Commits

Reviewing files that changed from the base of the PR and between 9402902 and f1e4fad.

📒 Files selected for processing (1)
  • CLAUDE.md

📝 Walkthrough

Walkthrough

CLAUDE.md adds an “Intent Layer” under “Global Invariants” with repository-wide rules for analysis flow, models, settings, thresholds, imports, Streamlit setup, error handling, and code style.

Changes

Repository Guidance

Layer / File(s) Summary
Intent layer rules
CLAUDE.md
Documents standardized analysis routing, plain dataclasses, cached settings access, configurable thresholds, lazy transformer imports, required Streamlit path setup, analysis failure handling, and formatting conventions.

Estimated code review effort: 1 (Trivial) | ~2 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/intent-layer-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.

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.

1 participant