docs: add CLAUDE.md with working rules and evaluation-honesty guardrails - #6
docs: add CLAUDE.md with working rules and evaluation-honesty guardrails#6vkosuri wants to merge 4 commits into
Conversation
Persistent per-repo context for AI-assisted sessions: the held-out-split-only reporting rule (with this repo's own 99%-vs-43% memorization lesson), security-pinned dependency note, exact CI commands, repo map, and the datasets-repo pickle/writer-split contract.
…s/**) Same rationale as the sibling repos: a markdown-only change can't affect py_compile/pytest results, so the full pipeline is pure wait time. paths-ignore only skips when EVERY changed file matches -- a mixed PR still runs everything.
|
Added a second commit: Generated by Claude Code |
Repo-tailored review guidance using the path-scoped instructions format (applyTo: "**"). Leads with evaluation honesty (split disclosure required on any accuracy claim, citing this repo's own 99%-vs-43% memorization lesson) and the torch.load/pickle security pin rationale.
|
Added Generated by Claude Code |
… consent) New working rule in CLAUDE.md and a matching review check in code-review.instructions.md. Points at this repo's own correct existing pattern (docs/impacx_onhw_analysis.md citing and independently reimplementing ImpAcX_OnHW, not copying it) as the model to follow.
|
Added a research-code provenance rule to both Generated by Claude Code |
There was a problem hiding this comment.
Pull request overview
Adds repo-wide “persistent context” documentation for AI-assisted sessions and reviewers, centering evaluation-honesty guardrails and security/dependency pin rationale, plus updates CI triggers to skip docs-only changes.
Changes:
- Added
CLAUDE.mdwith working rules, repo map, and CI command cheatsheet. - Updated CI workflow triggers to ignore docs-only changes (
**/*.md,docs/**). - Added
.github/instructions/code-review.instructions.mdto standardize review focus (provenance, security, evaluation honesty).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
CLAUDE.md |
New persistent context/rules doc for AI sessions, including CI commands and repo guardrails. |
.github/workflows/ci.yml |
Adjusts CI triggers so markdown/docs-only changes don’t run the pipeline. |
.github/instructions/code-review.instructions.md |
Adds structured review instructions emphasizing provenance, security, and evaluation honesty. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| `docs/impacx_onhw_analysis.md` explicitly analyzes ImpAcX_OnHW's | ||
| pipeline and `plot_results.py` is rebuilt "in the style of" its | ||
| `plot_kNN_results.py" — independently reimplemented, cited, not copied. |
| pip install -r requirements.txt --extra-index-url https://download.pytorch.org/whl/cpu # CPU/CI | ||
| python -m py_compile *.py # syntax gate (CI does this) | ||
| pytest # tests/ — split, writer inference, augmentation, CTC | ||
| python onhw_seq2seq.py --demo # verifies the seq2seq pipeline on synthetic data, no dataset needed |
| - Any use of `torch.load`/pickle-based loading on data that isn't fully | ||
| trusted (e.g., a checkpoint from an external source) should use | ||
| `weights_only=True` or equivalent — this is exactly the class of bug | ||
| CVE-2025-32434 was. |
| name: CI | ||
|
|
||
| on: | ||
| # Docs-only changes (README/CLAUDE.md/docs/**) skip this whole pipeline -- | ||
| # nothing here builds or tests markdown. A push/PR that touches even one | ||
| # non-doc file still runs everything; paths-ignore only fires when EVERY | ||
| # changed file matches. |
Adds a repo-root
CLAUDE.md— the persistent context file AI coding sessions load automatically, so working rules and project knowledge carry across sessions instead of being re-derived each time. Completes the org-wide sweep (web-live #31, 20factor-analyser #28, firmware #126, datasets #7, bujo.js #2).Contents (verified against the README,
ci.yml, andpytest.ini):py_compilesyntax gate,pytest, and the--demoself-check for the seq2seq pipeline.cnn_gnn.py.One file added, nothing else touched.
Generated by Claude Code