Skip to content

Update CLAUDE.md and HACKING.md to reflect current codebase#3585

Open
cuihtlauac wants to merge 2 commits into
mainfrom
update-claude-md-hacking-md
Open

Update CLAUDE.md and HACKING.md to reflect current codebase#3585
cuihtlauac wants to merge 2 commits into
mainfrom
update-claude-md-hacking-md

Conversation

@cuihtlauac
Copy link
Copy Markdown
Collaborator

Summary

  • CLAUDE.md: Replace stale ood-gen references with data-packer/data-scrape. Add missing sections: data/ directory overview, dependency pinning (lists all 5 files carrying the opam-repo pin), environment variables table, CI workflows descriptions, deployment pipeline details, and package documentation info.
  • HACKING.md: Expand tool/ in the repo structure tree (was a one-liner mentioning the removed ood-gen; now lists all 5 tools). Add missing ocamlorg_static to src/ listing. Replace inaccurate "three (3) places" dependency pin description with explicit file list.

Test plan

  • Verify all referenced paths exist in the repo
  • Verify env var defaults match src/ocamlorg_web/lib/config.ml and src/ocamlorg_package/lib/config.ml
  • Verify opam-repo pin appears in all listed files

🤖 Generated with Claude Code

cuihtlauac and others added 2 commits March 26, 2026 15:50
- Replace stale ood-gen references with data-packer/data-scrape
- Add missing sections to CLAUDE.md: data/ directory, dependency
  pinning, environment variables, CI workflows, deployment pipeline,
  package documentation
- Fix HACKING.md repo structure: expand tool/ listing, add
  ocamlorg_static, enumerate pinned files explicitly

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Formatting and linting failures are the #1 cause of CI failures.
Add a "Before Submitting a PR" section to both CLAUDE.md and
HACKING.md documenting the need to run `make fmt` and markdown
lint before pushing.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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