Repository navigation
Commit 5f1a6a0
docs: the Action card overstated what CI enforcement does (#37)
The "GitHub Action" card on the home page said the Action is
*"enforcement in CI that a contributor cannot skip"*.
Two other places on the same page are careful about exactly this:
- the pricing note — *"the only way Commit Check blocks a merge is if
you make it a required check yourself"*
- the FAQ — *"Make the Action or the App a required status check and a
violating change cannot merge"*
So the card was the odd one out, and it is the one a reader meets first.
An Action that is not a required status check runs, reports, and the
pull request merges anyway.
The new wording keeps the contrast the card was drawing with the
pre-commit hook card above it — which a contributor genuinely *can* skip
with `--no-verify` — and states the condition for blocking a merge:
> Runs in CI whether or not the hook ran. Make it a required check and a
violation cannot merge, with per-rule outputs later steps can gate on.
Found by CodeRabbit on #36, which merged before the fix could be applied
there.
`pytest tests/` passes (10) and `mkdocs build --strict` is clean.
---
🤖 Generated with [Claude Code](https://claude.com/claude-code)
https://claude.ai/code/session_018xYa7m3qup5wyN5MaXFgf6
---
_Generated by [Claude
Code](https://claude.ai/code/session_018xYa7m3qup5wyN5MaXFgf6)_
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>1 parent c3cda24 commit 5f1a6a0
1 file changed
Lines changed: 2 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
248 | 248 | | |
249 | 249 | | |
250 | 250 | | |
251 | | - | |
252 | | - | |
| 251 | + | |
| 252 | + | |
253 | 253 | | |
254 | 254 | | |
255 | 255 | | |
| |||
0 commit comments