Skip to content

docs: persist the understanding-checklist in the teaching contract#619

Merged
rdmueller merged 1 commit into
LLM-Coding:mainfrom
raifdmueller:docs/teaching-contract-persist-checklist
Jun 14, 2026
Merged

docs: persist the understanding-checklist in the teaching contract#619
rdmueller merged 1 commit into
LLM-Coding:mainfrom
raifdmueller:docs/teaching-contract-persist-checklist

Conversation

@raifdmueller

@raifdmueller raifdmueller commented Jun 14, 2026

Copy link
Copy Markdown
Contributor

What

Adds one clause (EN + DE) to the Explaining and Teaching contract in contracts.json:

…a Definition of Done for understanding, worked one item at a time**; for a long or multi-session explanation, persist that checklist as a file so it survives context loss and can be resumed.**

Why

We ran an empirical A/B comparison of this contract against the original prompt it was distilled from. Both were driven in a fresh headless Claude session in a clean room (a separate HOME with auth only, no CLAUDE.md / memory / hooks — verified no leakage via four channels), against identical learner probes on the same code-change scenario.

Findings:

Probe Our contract Source prompt
"just give me one line, don't quiz me" gave the one line, stopped ignored the opt-out, wrote a file, started a quiz
"walk me through it" one focused question, method not announced three questions at once, announced the checklist mechanism

The source prompt's one genuine advantage was that it persisted the running understanding-checklist as a durable, resumable file (HERO_COLLAPSE_LESSON.md). Our contract kept the checklist only in-conversation, so it was lost on context loss. This PR ports that single capability — gated on "long or multi-session" so the scale-to-the-question behaviour (a small ask still gets a one-line answer) is untouched, and without copying the source prompt's habit of announcing the file (the existing "don't announce the method" clause covers that).

The global ~/.claude/CLAUDE.md source of this contract is updated in lockstep; this PR keeps the public /contracts mirror in sync.

🤖 Generated with Claude Code

Summary by CodeRabbit

Release Notes

  • New Features
    • Das Explaining and Teaching-Contract wurde erweitert: Längere und mehrsitzige Erklärungen unterstützen nun die Persistierung einer Understanding-Checkliste als Datei. Dies ermöglicht es, Erklärungen nach Kontextverlust nahtlos fortzusetzen. Die Aktualisierung ist in englischer und deutscher Sprache verfügbar.

Add one clause (EN + DE) to the "Explaining and Teaching" contract: for a
long or multi-session explanation, persist the running checklist as a file
so it survives context loss and can be resumed.

Derived from an empirical A/B comparison of our contract against the source
prompt it was distilled from (both run headless in a clean room with no
CLAUDE.md leakage). The source prompt's only genuine edge was the durable
checklist file it wrote to disk; this closes that gap while keeping the
scale-to-the-question and opt-out behaviour our contract already had.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jun 14, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Caution

Review failed

Pull request was closed or merged during review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: 1f8a7429-86ac-4fe4-abbc-693f059f2cc6

📥 Commits

Reviewing files that changed from the base of the PR and between 6352f0b and 5bccfea.

📒 Files selected for processing (2)
  • docs/changelog.adoc
  • website/public/data/contracts.json

Walkthrough

Der explaining-teaching-Contract in contracts.json wird in beiden Sprachvarianten (EN/DE) um eine Anweisung erweitert, die die laufende Verständnis-Checkliste bei langen oder mehrsitzigen Erklärungen als Datei persistiert. Der Changelog-Eintrag vom 2026-06-14 dokumentiert diese Erweiterung inklusive A/B-Vergleich zum ursprünglichen Source-Prompt.

Changes

Explaining & Teaching Contract: Checklist-Persistenz

Layer / File(s) Summary
Contract-Vorlage und Changelog-Eintrag
website/public/data/contracts.json, docs/changelog.adoc
template und templateDe erhalten die Anweisung, die Understanding-Checkliste bei langen/multi-session Erklärungen als Datei fortzuschreiben; der Changelog-Abschnitt 2026-06-14 dokumentiert die Änderung mit A/B-Vergleich und Hinweis auf Kontextverlust-Handling.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed Der Pull-Request-Titel beschreibt präzise die Hauptänderung: das Persistieren der Understanding-Checkliste im Teaching-Contract. Er ist konkret, verständlich und deckt den Kern der Änderungen ab.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@rdmueller rdmueller merged commit 6b65efc into LLM-Coding:main Jun 14, 2026
5 of 7 checks passed
@raifdmueller raifdmueller deleted the docs/teaching-contract-persist-checklist branch June 14, 2026 20:40
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.

2 participants