Skip to content

DOC: document prek and autofix.ci - #315

Merged
redeboer merged 15 commits into
mainfrom
prek-and-autofix-ci
Oct 20, 2026
Merged

redeboer merged 15 commits into
mainfrom
prek-and-autofix-ci

Conversation

@redeboer

@redeboer redeboer commented Sep 10, 2026 •

Copy link
Copy Markdown
Member

📝 Documentation

  • Replaced the "Pre-commit" section of docs/develop.md with a "Prek" section: installing prek with uv tool install prek, activating hooks with prek install --prepare-hooks, and running all checks with prek run -a. The old (pre-commit)= label is kept so that existing cross-references still resolve.
  • Added a tip for developers coming from pre-commit on replacing the untracked Git hook shims, either by reinstalling them or with policy migrate, and on uninstalling pre-commit and pre-commit-uv.
  • Documented the style task as a wrapper around prek run -a (with uv, Pixi, and prek tabs) and the upgrade task that runs prek autoupdate, and noted that the lock workflow bumps hook revisions the same way.
  • Added an "autofix.ci" subsection that explains how style fixes are committed back to pull requests, why the workflow file must be named autofix.ci.yml, how forks and bot-authored commits are handled, and that the style workflow skips its own push job when autofix.ci is present.
  • Replaced the pre-commit.ci badge in README.md with a prek badge.
  • Removed the fullscreen button from the website header (use_fullscreen_button in docs/conf.py).
  • Unwrapped hard-wrapped paragraphs in docs/develop.md.

Squash commit messages

* DOC: document the `style` and `upgrade` tasks
* DOC: explain how autofix.ci commits style fixes
* DOC: explain how to replace `pre-commit` Git hooks
* DOC: remove the fullscreen button
* DOC: replace pre-commit.ci badge with `prek` badge
* DOC: unwrap paragraphs in developer guide

@redeboer redeboer added 📝 Docs Improvements or additions to documentation 🖱️ DX Improvements to the Developer Experience labels Sep 10, 2026
@redeboer
redeboer added this pull request to stack #316 September 10, 2026 09:46
@redeboer redeboer self-assigned this Sep 10, 2026
Base automatically changed from dependabot/lock-e1a8396f4b to main October 12, 2026 13:39
# Conflicts:
#	.cspell.json
#	.github/workflows/cd.yml
#	.github/workflows/ci.yml
#	.github/workflows/clean-caches.yml
#	.github/workflows/lock.yml
#	.github/workflows/pr-linting.yml
#	.github/workflows/release-drafter.yml
#	.pre-commit-config.yaml
#	README.md
#	docs/develop.md
#	pyproject.toml
#	uv.lock
@redeboer
redeboer marked this pull request as ready for review October 20, 2026 08:41
@redeboer redeboer changed the title DOC: update developer instructions for prek and autofix.ci DOC: update developer instructions for prek and autofix.ci Oct 20, 2026
@redeboer redeboer changed the title DOC: update developer instructions for prek and autofix.ci DOC: document prek and autofix.ci Oct 20, 2026
@redeboer redeboer removed the 🖱️ DX Improvements to the Developer Experience label Oct 20, 2026
@redeboer
redeboer merged commit eef994f into main Oct 20, 2026
25 of 26 checks passed
@redeboer
redeboer deleted the prek-and-autofix-ci branch October 20, 2026 11:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📝 Docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove the fullscreen button from the documentation Update developer instructions for prek and autofix.ci

1 participant