knowtation-no-docs-only-pr.mdc
sha256:c07f2f34a0db9f43fe866f157d1935322008545ff8940c06c7c921eb219c55ab
NXP-b DONE: independent BV-r2 pass + ISR (SD-17)
Human
minor
⚠ breaking
2 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
1 commit
sha256:c07f2f34a0db9f43fe866f157d1935322008545ff8940c06c7c921eb219c55ab
NXP-b DONE: independent BV-r2 pass + ISR (SD-17)
Human
minor
⚠
2 days ago