Skip to content

docs: add missing CLAUDE.md to onex_change_control [OMN-2973] - #14

Merged
jonahgabriel merged 1 commit into
mainfrom
jonah/omn-2973-phase-3-remediation-onex-change-control
Feb 28, 2026
Merged

jonahgabriel merged 1 commit into
mainfrom
jonah/omn-2973-phase-3-remediation-onex-change-control

Conversation

@jonahgabriel

Copy link
Copy Markdown
Contributor

Summary

Part of OMN-2973 (Phase 3: Anti-AI-Slop Remediation — Quick Wins).

Creates the missing CLAUDE.md for the onex_change_control repository. This repo had no Claude Code guidance file, making it opaque to automated agents.

The new CLAUDE.md documents:

  • Repository purpose: centralized governance, schema distribution, drift prevention
  • Architecture: ModelTicketContract, ModelDayClose, CLI entry points, validation helpers
  • Naming conventions (Model*/Enum* following omnibase_core)
  • Development commands (note: this repo uses Poetry, not uv)
  • Schema purity rule (D-008): no env/fs/network/time in schema modules
  • Versioning policy: 1:1 package version ↔ schema version
  • Downstream usage patterns

Structure follows omnibase_spi/CLAUDE.md.

Test plan

  • CLAUDE.md created and committed
  • Content verified against actual src/onex_change_control/ structure

Documents the repository's purpose (centralized governance/schema distribution
for cross-repo drift prevention), architecture, naming conventions, development
commands, the D-008 schema purity rule, versioning policy, and downstream usage.

Follows the structure of omnibase_spi/CLAUDE.md. Includes a note that this repo
uses Poetry rather than uv, since the pyproject.toml uses poetry-core build backend.
@coderabbitai

coderabbitai Bot commented Feb 28, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@jonahgabriel has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 0 minutes and 4 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 80233d8 and aafcdc0.

📒 Files selected for processing (1)
  • CLAUDE.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch jonah/omn-2973-phase-3-remediation-onex-change-control

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

@claude

claude Bot commented Feb 28, 2026

Copy link
Copy Markdown

PR Review: docs: add missing CLAUDE.md to onex_change_control [OMN-2973]

This is a documentation-only PR. I verified the content against the actual repository structure.

What's accurate ✅

  • Architecture tree matches src/onex_change_control/ exactly: enums/, models/, scripts/, validation/ are all present with the correct contents.
  • Naming convention table correctly reflects the actual filenames (enum_drift_category.py, model_day_close.py, etc.).
  • CLI entry points (validate-yaml, check-schema-purity) are confirmed in pyproject.toml and map to the correct scripts.
  • --warn-only flag is verified to exist in check_schema_purity.py (lines 621, 691–694).
  • Key Documentation paths (docs/VERSIONING_POLICY.md, docs/TEMPLATE_GUIDE.md, docs/planning/IMPLEMENTATION_PLAN.md, docs/design/DECISION_LOG.md, docs/design/DESIGN_DRIFT_CONTROL_SYSTEM.md) all resolve correctly.
  • Templates (templates/ticket_contract.template.yaml, templates/day_close.template.yaml) verified present.
  • Poetry-not-uv callout is prominent and correct.

Minor issues to consider

1. Example path doesn't exist in this repo (cosmetic)

# Validate a YAML artifact
poetry run validate-yaml contracts/OMN-123.yaml

There is no contracts/ directory in this repo. For agents reading this file, using a real path would be more grounding. Consider:

# Validate a YAML artifact
poetry run validate-yaml drift/day_close/2025-12-19.yaml

This makes the example immediately runnable and confirms the tooling works against the actual artifact store.

2. docs/REVIEW_READINESS.md not mentioned

The file docs/REVIEW_READINESS.md exists in the repo but isn't listed under Key Documentation. If it's a meaningful onboarding artifact, it's worth adding. If it's ephemeral/WIP, no change needed.

3. Wording: "Example / historical day_close artifacts"

├── drift/day_close/         # Example / historical day_close artifacts

The drift/day_close/ files (e.g., 2025-12-19.yaml) are real daily reconciliation artifacts, not examples. Suggested:

├── drift/day_close/         # Daily reconciliation artifacts (ModelDayClose)

Summary

The content is accurate, well-structured, and follows the org's CLAUDE.md pattern. The three items above are all minor. The most impactful fix would be replacing contracts/OMN-123.yaml with an actual drift/day_close/ path so the CLI example is immediately usable by an agent or developer without needing to look elsewhere.

Verdict: Approve with optional nits. The core goal — giving Claude Code agents accurate, actionable context for this repo — is achieved.

@jonahgabriel
jonahgabriel merged commit 0cda337 into main Feb 28, 2026
7 checks passed
@jonahgabriel
jonahgabriel deleted the jonah/omn-2973-phase-3-remediation-onex-change-control branch April 4, 2026 02:16
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