|
| 1 | +### Codex Session Notes |
| 2 | + |
| 3 | +**Command** |
| 4 | + |
| 5 | +* Run: `!summarize [slug]` |
| 6 | + |
| 7 | +**Where to write** |
| 8 | + |
| 9 | +* Path: `./.codex/sessions/[slug]-[date].md` |
| 10 | +* `slug`: kebab-case from the session topic (ASCII, ≤40 chars, no spaces). |
| 11 | +* `date`: `YYYY-MM-DD` in UTC. |
| 12 | + |
| 13 | +**Update protocol (when `!summarize` is called)** |
| 14 | + |
| 15 | +1. If the file doesn’t exist, create it with the template below and fill all placeholders. |
| 16 | +2. Update `last_updated` to the current ISO timestamp. |
| 17 | +3. Refresh **TL;DR** (≤120 words) to reflect the latest state. |
| 18 | +4. Append a new entry to **Turn log** with: role, timestamp, what changed (bullets), key code refs/paths touched. |
| 19 | +5. Extend **Actions taken**, **Decisions & rationale**, **Open questions**, **Next actions** as needed (dedupe; prefer edits over repetition). |
| 20 | +6. Keep **Running summary** ≤ \~200 words; compress older detail into Turn log. |
| 21 | +7. Never paste long code; reference files/functions/lines instead. |
| 22 | + |
| 23 | +**Style rules** |
| 24 | + |
| 25 | +* Be concise, factual, and action-oriented. No fluff. |
| 26 | +* Prefer bullets over prose; present tense; avoid “I”. |
| 27 | +* Use explicit file paths (`repo/file.py:func`), commands in single quotes, and UTC timestamps `[YYYY-MM-DD HH:MM]`. |
| 28 | +* No PII, secrets, tokens, or full stack traces. Link or reference instead. |
| 29 | +* Idempotent edits: do not duplicate prior bullets; update in place. |
| 30 | +* Touch only files inside this repo; create directories if missing. |
| 31 | + |
| 32 | +--- |
| 33 | + |
| 34 | +### Standard Template (fill all placeholders) |
| 35 | + |
| 36 | +``` |
| 37 | +The most recent discussion I had with codex was the following. Please use these notes as informative context, so you can catch up and we can re-start the conversation accordingly. |
| 38 | +
|
| 39 | +topic: <short topic> |
| 40 | +slug: <kebab-case-slug> |
| 41 | +date: <YYYY-MM-DD> (UTC) |
| 42 | +last_updated: <UTC ISO 8601> |
| 43 | +participants: [user, assistant] |
| 44 | +
|
| 45 | +# TL;DR (≤120 words) |
| 46 | +- <single concise summary capturing goal, current state, next critical step> |
| 47 | +
|
| 48 | +# User desires |
| 49 | +- <succinct bullets of outcomes the user wants> |
| 50 | +
|
| 51 | +# Specifics of user desires (scope & constraints) |
| 52 | +- <key constraints, definitions of done, non-goals, acceptance criteria> |
| 53 | +
|
| 54 | +# Actions taken (chronological) |
| 55 | +1. [YYYY-MM-DD HH:MM] <what was done / command / artifact produced> |
| 56 | +2. <next step> … |
| 57 | +
|
| 58 | +# Decisions & rationale |
| 59 | +- [time] Decision: <decision>. Why: <brief reason/impact/tradeoffs>. |
| 60 | +
|
| 61 | +# Helpful hints about conversation & relevant code paths |
| 62 | +- Path: <repo/path/file.py:func> — <why it matters> |
| 63 | +- Command: '<cli args>' — <purpose> |
| 64 | +- Link: <url> — <what it answers> |
| 65 | +
|
| 66 | +# Open questions / risks |
| 67 | +- <unknown or risk> → <owner/next step to resolve> |
| 68 | +
|
| 69 | +# Next actions (checklist) |
| 70 | +- [ ] <next concrete task> (owner, expected outcome) |
| 71 | +- [ ] … |
| 72 | +
|
| 73 | +# Turn log (append-only) |
| 74 | +- [YYYY-MM-DD HH:MM] role=assistant — <what changed in this turn; bullets> |
| 75 | +- [YYYY-MM-DD HH:MM] role=user — <key asks/clarifications> |
| 76 | +
|
| 77 | +# With this context in mind, I have a follow up query: |
| 78 | +<one crisp question or instruction that advances the work> |
| 79 | +``` |
| 80 | +--- |
0 commit comments