Skip to content

Commit 1619420

Browse files
committed
docs: document PR ancestry and description quality gates
1 parent 05cb93b commit 1619420

3 files changed

Lines changed: 16 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,11 @@ integration line to another, or rebasing a stale branch onto the current head,
6161
is ordinary maintenance rather than noise — open it as a normal pull request
6262
and name the source commits in the description.
6363

64+
The required **`enforce-target`** CI check rejects pull requests whose head
65+
ancestry sits on the **`main`** tip while far behind **`dev`** or **`dev2-go`**,
66+
and rejects empty, thin, or malformed descriptions; authors with repository
67+
push permission skip the ancestry heuristic only.
68+
6469
[`MAINTAINERS.md`](./MAINTAINERS.md) is authoritative for review and merge
6570
policy (approvals, CI requirements, security review, promotion). This file
6671
summarizes; it never overrides it.

MAINTAINERS.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@ through GitHub repository settings.
2323
distinguish scoped Go port work from anything else aimed at `dev2-go`, so
2424
that boundary is enforced in review: redirect an out-of-scope pull request to
2525
`dev` rather than treating the automation's silence as approval.
26+
- The required **`enforce-target`** CI check rejects pull requests whose head
27+
ancestry sits on the **`main`** tip while far behind **`dev`** or **`dev2-go`**,
28+
and rejects empty, thin, or malformed descriptions; authors with repository
29+
push permission skip the ancestry heuristic only.
2630
- A pull request requires approval from at least one maintainer and successful required CI checks
2731
before merge.
2832
- Authors do not approve their own pull requests.

docs-site/src/content/docs/contributing.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,13 @@ integration line to another, or rebasing a stale branch onto the current head,
103103
is normal contribution rather than noise — note the source commits in the
104104
description.
105105

106+
## Pull requests
107+
108+
- Target **`dev`** (or **`dev2-go`** only for scoped Go native-port work). Do not open ordinary feature or fix pull requests against **`main`**.
109+
- Branch from the current **`dev`** tip, not from **`main`**. The required **`enforce-target`** check rejects heads whose merge base sits on the **`main`** tip while the branch is far behind the pull request base (the failure mode seen in #644).
110+
- Write a real description: a **Summary** of what changed and why, plus a **Test plan** (or equivalent substance). Empty bodies, placeholder-only text, and descriptions that use escaped `\n` instead of real line breaks fail the check.
111+
- Workflow changes in this repository use **`pull_request_target`**. Updated enforcement logic applies only after the workflow is promoted to the repository default branch — the same operational caveat documented in #631.
112+
106113
## Project maintainers
107114

108115
The current maintainers, their responsibilities, and the review and merge policy are documented in

0 commit comments

Comments
 (0)