Files
uscogdata/docs/pm/JOURNAL.md
T
Jared Knowles 2e317d3a0f
Mirror to GitHub / mirror (push) Successful in 10s
R-CMD-check / check (push) Successful in 3m55s
chore: adopt compass for project tracking
Three workstreams -- the query verbs, the corpus and how it is mounted, and the
docs that explain both. Each can go stale independently, which is what the
workstream boundary is for: a change to a verb obligates the vignettes, a change
to the corpus obligates NEWS.

All six open issues now carry ws/ and type/ labels, applied additively so #36
kept its existing kodor/, severity/, south-guide and verdict/ labels. The
generated board is pinned as issue #68.

.roborev.toml carries review guidelines composed from a shared baseline, the R
package overlay, and this project's own conventions read out of CLAUDE.md: the
ensure_session-then-dbGetQuery order, the tbl_df-with-provenance return
contract, coerce_govid_input at the boundary, the two SQL layers, no arrow, and
withr as tests-only.

The .gitignore change is load-bearing. pkgdown output made docs/ ignored, which
would have left every compass file untracked and unable to travel to another
machine. Git cannot re-include anything beneath an excluded directory, so the
rule had to list children instead. That forced an anchoring change: a bare
"docs/" matches at any depth, "/docs/*" only at the root, so the fixture corpus
docs directory needed an explicit rule to stay excluded as before.
2026-08-23 16:17:20 -04:00

595 B

Project journal

Append-only, newest first. Entries are never edited — the value of this file is that it records what was believed at the time, including the parts that turned out wrong. Where things stand today is in STATUS.md, which is generated.

Four lines per entry. The analysis belongs in the issue or the decision record; this file carries the reasoning and the pointers.

  • Why — the driver. The one line git cannot reconstruct later.
  • Obligates — issues this change created elsewhere. Numbers, not prose.
  • Refs — commits, issues, decision records.