Skip to content

Commit 82cbcc9

Browse files
committed
docs: keep the generic PR template as a deliberate org default
1 parent 6e48e9f commit 82cbcc9

2 files changed

Lines changed: 9 additions & 8 deletions

File tree

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,4 @@
1313
- [ ] Type check passes (`ty`)
1414
- [ ] Tests pass and new behavior is covered
1515
- [ ] Build succeeds (`uv build`) if packaging or build config changed
16-
- [ ] Docs updated if behavior or public API changed
1716
- [ ] Repo metadata stays consistent across the three surfaces (GitHub description, pyproject `description`, profile blurb) if this touches packaging

‎AGENTS.md‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# modern-python org conventions
1+
# modern-python/.github
22

3-
The conventions below apply across **all** repos in the `modern-python` org, not
4-
just this one. [`CONTEXT.md`](CONTEXT.md) says what this repo is and owns the
5-
vocabulary — read it before naming a mark, a colourway, or a surface.
3+
Conventions for this repo. Every other repo in the org carries its own `AGENTS.md`
4+
and none of them read this one, so nothing here reaches them. The org-wide document
5+
contributors read is [`CONTRIBUTING.md`](CONTRIBUTING.md), which every repo inherits.
6+
[`CONTEXT.md`](CONTEXT.md) says what this repo is and owns the vocabulary — read it
7+
before naming a mark, a colourway, or a surface.
68

79
## Naming & branding
810

@@ -80,9 +82,9 @@ choose, and no `planning/` tree. A trivial PR (typo, dep bump, formatter, CI twe
8082
ships a conventional-commit title with no body ceremony.
8183

8284
> This repo's `.github/PULL_REQUEST_TEMPLATE.md` is the **org default**, inherited by
83-
> every repo without a local one, and most of them still run the older `planning/`
84-
> convention — so it still carries the generic form. Replacing it is tracked
85-
> separately; write PR bodies in the shape above regardless.
85+
> every repo without a local one. It stays the generic form deliberately: it reaches
86+
> only a human opening a PR in the web UI, and it has to hold for repos on either
87+
> convention. Write PR bodies in the shape above regardless.
8688
8789
Two things outlive the PR, and there are exactly two places to put them: an
8890
alternative **rejected** with reasoning becomes an ADR in [`docs/adr/`](docs/adr/)

0 commit comments

Comments
 (0)