docs: add session guidance for same-session, compact, or fresh start - #1544
docs: add session guidance for same-session, compact, or fresh start#1544Amanjyot-P wants to merge 1 commit into
Conversation
Explains when to stay in the same session, compact, or start a fresh session at a durable handoff point (plan committed, code pushed, review report landed) in the compound engineering loop.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: af9fa6646e
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
|
|
||
| - **Stay in the same session** while you're inside one step (planning, or one `/ce-work` implementation pass). The model has the context it needs; clearing it early just forces a re-read of the same files. | ||
| - **Compact** when a session has run long (large diffs, many tool calls, or you're approaching the host's context limit) but you're still mid-step and want to keep recent decisions in view. Compact after a plan is written or a `/ce-code-review` pass completes, not mid-edit. | ||
| - **Start a fresh session** at a durable handoff point — after a plan is committed, after code is committed and pushed, or after a review report lands — so the next step starts from the artifact on disk instead of a long transcript. `/ce-plan`, `/ce-work`, and `/ce-code-review` all read prior artifacts back in, so a new session loses no information a completed step already wrote down. Use [`/ce-handoff`](docs/skills/ce-handoff.md) to hand off mid-step work that has no artifact yet. |
There was a problem hiding this comment.
Keep the review-to-compound handoff in the same session
For users following the standard loop, the next step after /ce-code-review is /ce-compound, but this recommendation tells them it is safe to start a fresh session first. A bare ce-compound captures the verified fix from the current conversation, and skills/ce-compound/SKILL.md:16-18 explicitly writes nothing when the session contains no solved problem; it does not discover or consume the prior code-review report. Consequently, following this guidance can skip the loop's namesake learning step. Recommend a fresh session only after compounding, or require passing explicit problem context/a handoff into the new session.
Useful? React with 👍 / 👎.
Code Review ResultsScope: PR #1544, base Confirmed FindingsNo findings survived the required evidence, confidence, quote-the-line, deduplication, and validation gates. Evidence and DispositionOne correctness reviewer proposed a P2 finding at The candidate was actionable, so it required the Stage 5b validation batch. The validator could not be launched because delegated agent spawning was unavailable. Under the validation gate, a P2 finding affected by validator infrastructure failure is dropped rather than emitted as a confirmed finding. It is recorded as a residual risk below and is not treated as an approved defect. ImpactNo confirmed PR-introduced defect is reported after the required gates. The unresolved documentation risk is that users may infer that a fresh session can recover review-derived context even though the review report is stored in a per-run artifact directory and FixesNo fixes were applied. This review is report-only. If the residual risk is confirmed in a later validation pass, the minimal proposed response is to remove Reviewer Lens Results
Actionable FindingsActionable findings: none. No finding remains in the downstream-resolver queue. Pre-existing IssuesNone reported. Residual Risks
Coverage
Verdict
Actionable findings: none. |
Summary
Adds a "Session guidance" section to the README explaining when Compound Engineering users should stay in the same session, compact context, or start a fresh session — anchored to the loop's durable handoff points (a committed plan, pushed code, or a landed review report) rather than session duration alone.
Addresses the request in #884: users running long sessions (especially with 1M context) weren't sure when to compact, clear, or continue, and the docs didn't call out that each loop step's artifact is itself the safe checkpoint.
Validation
bun run release:validate— passbun run plugin:validate— pass (marketplace + plugin manifest)bun test tests/release-metadata.test.ts tests/skill-conventions.test.ts— 304 pass, 0 fail (README-consistency and skill-convention suites)bun run test(full suite) — 3615 pass / 12 fail; the 12 failures are pre-existing timing-sensitive cross-model-routing and PR-watcher subprocess tests unrelated to this docs-only change (no source/skill files touched).Security Disclosure
No security-relevant changes. This is a documentation-only change to
README.md— no shell/exec, path handling, converters, credentials, or dependencies touched.Agent Disclosure