From 3e57d9d59b78bc76d17e93a6c6cccfcc20fe00b4 Mon Sep 17 00:00:00 2001 From: Louis Moresi Date: Wed, 28 Oct 2026 02:33:40 +0000 Subject: [PATCH 1/2] CONTRIBUTING: a note is assembled from journal entries Underworld development team with AI support from Claude Code --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 01e8040..8eebbd3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -240,6 +240,15 @@ something works, not how hard it was to make work. - **Every figure and table ships the script that made it**, in the note's `figures/src/`, beside the figures it draws. A number a reader cannot regenerate is an assertion. +- **A note is assembled from journal entries, and a finding made while writing + one is an entry first.** The + [Underworld journal](https://github.com/underworldcode/journal) holds the + dated record (what was tried, what happened, what we now think, with the run + and the commit linked); a note explains what the entries established. Cite the + entries the figures and numbers came from in the note's front matter or + `README`, so a reviewer can go back to the run, and write a measurement made + for the note as an entry before it goes into the note, since the entry is the + provenance the deposited PDF cannot carry. - **`examples/` holds what a reader is meant to launch**: the notebooks a Binder link opens, and the scripts and data they read. A script that only draws a figure goes in `figures/src/`, so a reader who opens `examples/` From 8b8c067f91ad8f1c0b5233e93bf8fbad6704ebdd Mon Sep 17 00:00:00 2001 From: Louis Moresi Date: Wed, 28 Oct 2026 02:51:02 +0000 Subject: [PATCH 2/2] CONTRIBUTING: the journal repository is underworldcode/underworld3-journal Underworld development team with AI support from Claude Code --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8eebbd3..e4a7391 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -242,7 +242,7 @@ something works, not how hard it was to make work. regenerate is an assertion. - **A note is assembled from journal entries, and a finding made while writing one is an entry first.** The - [Underworld journal](https://github.com/underworldcode/journal) holds the + [Underworld journal](https://github.com/underworldcode/underworld3-journal) holds the dated record (what was tried, what happened, what we now think, with the run and the commit linked); a note explains what the entries established. Cite the entries the figures and numbers came from in the note's front matter or