cmoriarty/braid
1
0
Fork 0
Code Issues 15 Pull requests Projects Releases Packages 1 Wiki Activity Actions

Every repository a run lands in should have a README, even a quick fix #140

New issue
Open
opened 2026-10-03 17:25:11 -04:00 by cmoriarty · 0 comments
cmoriarty commented 2026-10-03 17:25:11 -04:00
Owner
Copy link

The hello world baseline (run 42, see #139) merged to main with no README. The only run instructions were in the PR summary ("run npm run dev") and the committed AGENTS.md, and an operator who opened index.html directly got a CORS error.

Nothing in the pipeline writes a README: the prompts tell agents to read one (prompts.py:1477, :2161, :2375, :2486), and the docs pipeline treats README as a docs file, but no step creates one. forgejo.py:849 also deliberately creates repos with no auto_init, so a new repo has none.

Proposal: a run that lands code in a repository with no README adds a short one: what the project is (from the brief), how to run it, how to run its tests. A scripted check (paths-exist:README* after the last agent step, or a docs-style check) holds the pipeline to it. A repo that already has a README keeps it, with the run's instructions updated only where the run changed them. The run instructions in the README are what the independent judge proposed in #139 would follow.

The hello world baseline (run 42, see #139) merged to `main` with no README. The only run instructions were in the PR summary ("run `npm run dev`") and the committed `AGENTS.md`, and an operator who opened `index.html` directly got a CORS error. Nothing in the pipeline writes a README: the prompts tell agents to read one (`prompts.py:1477`, `:2161`, `:2375`, `:2486`), and the docs pipeline treats `README` as a docs file, but no step creates one. `forgejo.py:849` also deliberately creates repos with no `auto_init`, so a new repo has none. Proposal: a run that lands code in a repository with no README adds a short one: what the project is (from the brief), how to run it, how to run its tests. A scripted check (`paths-exist:README*` after the last agent step, or a `docs`-style check) holds the pipeline to it. A repo that already has a README keeps it, with the run's instructions updated only where the run changed them. The run instructions in the README are what the independent judge proposed in #139 would follow.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
archive/prefect-kestra-experiments
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
cmoriarty/braid#140
No description provided.