docstats: Instructions file for Codex

Agent Instructions

Issue Tracking

This project uses bd (beads) for issue tracking. Run bd prime for workflow context, or install hooks (bd hooks install) for auto-injection.

Quick reference:

• bd ready - Find unblocked work
• bd show <id> - View issue details
• bd create "Title" --type task --priority 2 - Create issue
• bd update <id> --claim - Claim work
• bd close <id> - Complete work
• bd dolt push - Push beads to remote

For full workflow details: bd prime

Maintenance & Quality

Benchmarking with the Golden Set

When modifying extraction logic (extraction.py) or metric calculations (metrics.py), you must verify that you haven't introduced unintended "drift" in the scores:

• Run Baseline: uv run python baseline_analysis.py
• Verify: Compare the output against samples/baseline_results.json.
• Quality Goal: Use these samples to perform "Hill Climbing"—iteratively adjusting code or content to meet specific readability targets.

Landing the Plane (Session Completion)

When ending a work session, you MUST complete ALL steps below. Work is NOT complete until git push succeeds.

MANDATORY WORKFLOW:

1. File issues for remaining work - Create issues for anything that needs follow-up
2. Run quality gates (if code changed) - Tests, linters, builds
3. Update issue status - Close finished work, update in-progress items
4. PUSH TO REMOTE - This is MANDATORY:

   git pull --rebase
   bd sync
   git push
   git status  # MUST show "up to date with origin"
   

5. Clean up - Clear stashes, prune remote branches
6. Verify - All changes committed AND pushed
7. Hand off - Provide context for next session

CRITICAL RULES:

• Work is NOT complete until git push succeeds
• NEVER stop before pushing - that leaves work stranded locally
• NEVER say "ready to push when you are" - YOU must push
• If push fails, resolve and retry until it succeeds