Skip to content

docs: PR rules leave small bundles to the developer and drop the checklist #241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
badcuban merged 1 commit into from
Sep 6, 2026
+14 −26
Merged

docs: PR rules leave small bundles to the developer and drop the checklist #241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 8 additions & 23 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,13 @@
<!--
READ BEFORE OPENING
<!-- Keep it small and focused. Open an issue first for non-trivial changes.
See CONTRIBUTING.md. -->

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
<!-- What was wrong, in a sentence or two. -->

<!-- Describe the change clearly and keep scope tight. -->
## Fix

## Why
<!-- What changed and why this approach. -->

<!-- Explain the problem being solved and why this approach is the right one. -->

## UI Changes

<!-- If this PR changes UI, include clear before/after screenshots.
If the change involves motion or interaction, include a short video.
Delete this section if not applicable. -->

## 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
<!-- If this touches the UI, add before/after screenshots here.
If it changes motion or interaction, add a short video. -->
3 changes: 2 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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' <filename substring>`.
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:

Expand Down
Loading