|
1 | | -# modern-python org conventions |
| 1 | +# modern-python/.github |
2 | 2 |
|
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. |
6 | 8 |
|
7 | 9 | ## Naming & branding |
8 | 10 |
|
@@ -80,9 +82,9 @@ choose, and no `planning/` tree. A trivial PR (typo, dep bump, formatter, CI twe |
80 | 82 | ships a conventional-commit title with no body ceremony. |
81 | 83 |
|
82 | 84 | > 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. |
86 | 88 |
|
87 | 89 | Two things outlive the PR, and there are exactly two places to put them: an |
88 | 90 | alternative **rejected** with reasoning becomes an ADR in [`docs/adr/`](docs/adr/) |
|
0 commit comments