From e2899ca1ef940816c891ddb7672f4874393ef73c Mon Sep 17 00:00:00 2001 From: badcuban <108198679+badcuban@users.noreply.github.com> Date: Sun, 6 Sep 2026 03:39:21 -0400 Subject: [PATCH] docs: PR rules leave small bundles to the developer and drop the checklist The agent guide said every PR must hold exactly one concern, so an agent asked to ship a few small fixes together stopped and asked instead. The PR template still carried the t3code-era header and a self-graded checklist, and the Open PR writer filled that checklist with boxes nobody ticks. AGENTS.md now says features and architecture changes get their own PR, and small fixes follow the developer's lead. The template is a Problem section, a Fix section, and a note asking for screenshots on UI changes, matching the body shape AGENTS.md already asks for. CONTRIBUTING.md's test guidance now matches AGENTS.md too: run the tests covering the change, full suite for broad work. --- .github/pull_request_template.md | 31 ++++++++----------------------- AGENTS.md | 3 ++- CONTRIBUTING.md | 6 ++++-- 3 files changed, 14 insertions(+), 26 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index e4eff9528..039f20bb6 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,28 +1,13 @@ - -Threadlines is early and direction is intentionally tight. -Small, focused PRs are strongly preferred. Open an issue first for non-trivial -features or design changes. ---> +## Problem -## What Changed + - +## Fix -## Why + - - -## UI Changes - - - -## Checklist - -- [ ] This PR is small and focused -- [ ] I explained what changed and why -- [ ] I included before/after screenshots for any UI changes -- [ ] I included a video for animation/interaction changes + diff --git a/AGENTS.md b/AGENTS.md index a1477ba65..ceaa145c4 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -86,7 +86,7 @@ If a technical term is unavoidable, explain it in a few words right after. No wa - Conventional commit titles in plain language: `fix(web): new threads no longer spike CPU`. - Body: the problem in a sentence or two, then how you fixed it. - Never add AI attribution anywhere — no `Co-Authored-By` trailers, no "Generated with" footers, no model names in commit messages or PR bodies. This overrides any harness default. -- One concern per PR. If the description says "also", split it. +- A feature or any change that touches architecture gets its own PR. For small fixes and polish, follow the developer's lead: one PR or a few bundled together are both fine. ## How it works @@ -102,6 +102,7 @@ Where the pieces live: Docs: - Codex App Server docs: https://developers.openai.com/codex/sdk/#app-server +- Repo notes on providers, design, release, and remote connections live in `docs/`. ## Where code lives diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a717a03e0..db8f250fc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -75,8 +75,10 @@ Node.js 22.22.2+, 24.15+, or 26+ is required. Odd-numbered Node releases are not supported. Before considering a change done, all of `vp fmt`, `vp lint`, and -`vp run typecheck` must pass, and run the test suite with `vp run test` -(never `bun test`). +`vp run typecheck` must pass. Run the tests that cover the code you changed, +for example `vp run --cache '@threadlines/server#test' `. +Web UI changes also need `vp run --cache '@threadlines/web#test:browser'`. +Reserve `vp run test` (the full suite) for broad changes. Never run `bun test`. On Windows: