aaronrene / overseer-kit public
knowtation-no-docs-only-pr.mdc
20 lines 749 B
Raw
sha256:106ef9e12cca7f3be3ffb2a6bd3abfa76f032dce453c9e5010d732a8d86f2e14 Reconcile reviewed credential compatibility 32254cd939885d9… Human patch 8 days ago
1 ---
2 description: Avoid docs-only PRs to main; commit locally on feature branches
3 alwaysApply: true
4 ---
5
6 # No docs-only pull requests to `main`
7
8 **Policy:** Do **not** open or merge a GitHub pull request to **`main`** whose
9 **only** changes are under `docs/` (handoffs, roadmaps, playbooks) when those
10 deploys trigger paid rebuilds — unless the operator explicitly requests an urgent docs merge.
11
12 ## What this rule is NOT
13
14 - **Not** "never commit docs" — **always** commit on a **feature branch** (Tier 1, SD-1).
15 - **Not** "never push" — **`git push` to the feature branch** is encouraged (backup/share).
16
17 ## What to do instead
18
19 Ship documentation updates **in the same PR** as the **code, tests, or CI** they belong to when
20 merging to `main`.
File History 2 commits
sha256:106ef9e12cca7f3be3ffb2a6bd3abfa76f032dce453c9e5010d732a8d86f2e14 Reconcile reviewed credential compatibility 32254cd939885d9… Human patch 8 days ago
sha256:c87cf2c2f03da507f66f93922cb339a2cbebb33ad6372a6039032fb09a20da12 Reconcile reviewed Overseer recovery d47291d5d9030de5ebef71… Human minor ⚠ 8 days ago