Skip to content

docs: add PR lifecycle flow to CONTRIBUTING.md #912

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
thepagent merged 7 commits into from
May 23, 2026
Merged

docs: add PR lifecycle flow to CONTRIBUTING.md #912

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
58eddd1
docs: add PR lifecycle flow to CONTRIBUTING.md
May 23, 2026
be3e157
docs: fix box alignment and split label transition table rows
May 23, 2026
412688a
docs: note immediate closing-soon for missing Discord URL
May 23, 2026
c915940
docs: align stale to 2 days, clarify re-check may re-apply closing-soon
May 23, 2026
f187867
docs: rewrite lifecycle diagram with checks-first flow and re-check loop
May 23, 2026
7e4600f
docs: clarify maintainer flips to pending-contributor when pending ac…
May 23, 2026
0e2e5ed
docs: add LGTM/approve/merge path from pending-maintainer
May 23, 2026
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
71 changes: 71 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,74 @@ cargo check
- Run `cargo fmt` before committing
- Run `cargo clippy` and address warnings
- Keep PRs focused — one feature or fix per PR

## PR Lifecycle

Every PR follows a label-driven lifecycle that keeps the review loop moving.

```
┌──────────────┐
│ PR Created │
└──────┬───────┘
│
▼
┌──────────────────────┐
│ Automated Checks │
│ (CI, rebase, etc.) │
└──────┬───────────────┘
│
├── all pass ──────────────────────►┌──────────────────────┐
│ │ pending-maintainer │
│ └──────────┬───────────┘
│ │
│ ├── LGTM → approve & merge (or request
│ │ another maintainer review)
│ │ stays pending-maintainer
│ │
│ └── pending actions for contributor
│ │
│ ▼
└── any fail ──────────────────────►┌──────────────────────┐
│ pending-contributor │◄─────────┐
└──────────┬───────────┘ │
│ │
│ stale 2 days │
│ (no author activity) │
▼ │
┌───────────────────┐ │
│ closing-soon │ │
│ (or immediate if │ │
│ blocker detected)│ │
└────────┬──────────┘ │
│ │
┌────────────┴──────────┐ │
│ │ │
▼ ▼ │
author comments 3 more days │
within 3 days no activity │
│ │ │
▼ ▼ │
┌────────────────────┐ ┌────────────┐ │
│ pending-maintainer │ │ PR Closed │ │
│ (labels removed) │ └────────────┘ │
└────────┬───────────┘ │
│ │
└── re-check fails ────────────────────┘
```

### Label Transitions

| Current State | Trigger | Action |
|---------------|---------|--------|
| `pending-contributor` | No author activity for 2 days | Add `closing-soon` |
| `closing-soon` | No author activity for 3 more days | Auto-close PR |
| `pending-contributor` | Author adds a comment | Remove `pending-contributor`, add `pending-maintainer` |
| `closing-soon` | Author adds a comment | Remove `closing-soon` and `pending-contributor`, add `pending-maintainer` |

### Key Rules

- **`pending-contributor`** — the ball is on the contributor; maintainers are waiting for updates.
- **`closing-soon`** — warning that the PR will be auto-closed if no response within 3 days.
- **Author comment always resets** — any comment by the PR author removes `pending-contributor` and `closing-soon`, flipping the PR back to `pending-maintainer`.
- **Re-check may re-apply `closing-soon`** — after the flip, automated checks still run. If blockers remain (e.g., missing Discord URL, CI failure, `needs-rebase`), `closing-soon` will be re-applied immediately, keeping the ball on the contributor.
- **Immediate `closing-soon`** — in some cases (e.g., missing Discord Discussion URL), `closing-soon` is applied immediately without waiting for the stale period.
Loading