Project Catch-Up Report Spec¶
This reference defines report conventions and enum values used by
project-catchup.
Required Section Order¶
### ๐ Summary### ๐ถ Review signals## Per-Commit Detail
๐ Summary Conventions¶
- Start with one BLUF sentence: commit count, contributor pattern, dominant theme.
- Render theme threads as a borderless row list โ not a pipe table. Chat
and docs viewers draw vertical borders on pipe tables; this layout matches
the horizontal-rule style of
AGENTS.mdPrerequisites. - Format:
**Thread** ยท **What landed**
---
**A.** Short thread title โ Supporting detail for this thread.
---
**B.** Next thread title โ Supporting detail for this thread.
- Rules:
- Header line: bold column labels separated by a middle dot (
ยท). - One
---horizontal rule immediately under the header (strong separator). - One
---horizontal rule between each thread row (light row separators). - Do not wrap thread rows in pipe-table syntax (
| โฆ |). - Thread label:
A.,B., etc. plus a short title; separate title from detail with an em dash (โ). - Optional last line after the final row: invite a focused deep-dive for one thread.
๐ถ Review Signal Labels¶
Render review signals with the same borderless row-list layout:
**Signal** ยท **Notes**
---
**๐ฆฃ Overloaded commits** โ One-sentence assessment.
---
**๐งช Test gap** โ One-sentence assessment.
- Use these exact labels in the Signal column (bold, including emoji):
๐ฆฃ Overloaded commits๐งช Test gap๐ Release hygiene๐ Conventions๐ Docs drift- Include all five rows even when the note is brief (for example "None observed this window.").
- One
---between each signal row; no pipe-table syntax.
Per-Commit Table (Exact Columns)¶
| Commit - when - Author | Gist of change | Msg vs files | App vs Tests | Size |
|---|---|---|---|---|
Enum Values¶
Msg vs files:
AlignedMixedVagueMismatch
App vs Tests:
OKPartialNo
Time Format¶
Use dd MMM HH:mm in 24-hour time (for example 06 May 14:14) when rendering
commit timing in the first column.