Skip to content

Add methodology workflow checklist to CLAUDE.md#96

Merged
igerber merged 1 commit into
mainfrom
docs/methodology-workflow-claude-md
Jan 21, 2026
Merged

Add methodology workflow checklist to CLAUDE.md#96
igerber merged 1 commit into
mainfrom
docs/methodology-workflow-claude-md

Conversation

@igerber
Copy link
Copy Markdown
Owner

@igerber igerber commented Jan 21, 2026

Summary

  • Add docs/methodology/REGISTRY.md to documentation section as first-class reference
  • Add new "Implementing Methodology-Critical Code" development checklist
  • Strengthen "Adding Warning/Error/Fallback Handling" checklist with Registry consultation and np.errstate guidance
  • Update "For Bug Fixes or Minor Enhancements" to require methodology registry updates

Methodology references (required if estimator / math changes)

  • Method name(s): N/A - no estimator/math changes
  • Paper / source link(s): N/A
  • Any intentional deviations from the source (and why): N/A

Validation

  • Tests added/updated: No test changes (documentation-only PR)
  • Backtest / simulation / notebook evidence (if applicable): N/A

Security / privacy

  • Confirm no secrets/PII in this PR: Yes

Context

PR #95 required multiple review rounds due to:

  1. Non-finite handling wasn't documented as intentional deviation from reference implementations
  2. Tests captured warnings but didn't assert on methodology-aligned behavior
  3. Edge case handling wasn't clearly tied to documented methodology

These CLAUDE.md changes would have prevented those issues by:

  • Requiring consultation of docs/methodology/REGISTRY.md before implementing methodology changes
  • Mandating documentation when deviating from R/Stata reference behavior
  • Requiring tests that assert warnings are raised AND the warned-about behavior occurred

Generated with Claude Code

Integrate Methodology Registry into development workflow:
- Add docs/methodology/REGISTRY.md to documentation section
- Add new "Implementing Methodology-Critical Code" checklist
- Strengthen "Adding Warning/Error/Fallback Handling" checklist
- Update bug fix requirements to include methodology updates

These changes ensure PR #95 issues are prevented by requiring:
- Consultation of REGISTRY.md before methodology changes
- Documentation of deviations from reference implementations
- Behavioral tests that assert warnings AND outcomes

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown

Overall assessment: ✅ Looks good

Executive summary

  • Documentation-only change; no estimator/methodology code touched.
  • Adds clear checklist to enforce consultation and updates of docs/methodology/REGISTRY.md.
  • No tests or code changes required for this PR.

Methodology

  • No findings. Changes are documentation-only (CLAUDE.md).

Code Quality

  • No findings.

Performance

  • No findings.

Maintainability

  • No findings.

Tech Debt

  • No findings.

Security

  • No findings.

Documentation/Tests

  • No findings. Documentation update is consistent and scoped (CLAUDE.md).

@igerber igerber merged commit 9953d2d into main Jan 21, 2026
1 check passed
@igerber igerber deleted the docs/methodology-workflow-claude-md branch January 21, 2026 15:38
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