Skip to content

Update quick start to use prek.toml#1576

Merged
j178 merged 1 commit intomasterfrom
quick-start
Feb 5, 2026
Merged

Update quick start to use prek.toml#1576
j178 merged 1 commit intomasterfrom
quick-start

Conversation

@j178
Copy link
Owner

@j178 j178 commented Feb 5, 2026

No description provided.

Copilot AI review requested due to automatic review settings February 5, 2026 14:57
@j178 j178 added the documentation Improvements or additions to documentation label Feb 5, 2026
@j178 j178 merged commit b516d66 into master Feb 5, 2026
21 checks passed
@j178 j178 deleted the quick-start branch February 5, 2026 14:58
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the quickstart documentation to recommend prek.toml (TOML format) instead of .pre-commit-config.yaml (YAML format) for new users, aligning with prek's native configuration format.

Changes:

  • Replaces YAML configuration example with TOML format in the quickstart guide
  • Updates the explanatory note to clarify that prek.toml is the native format while maintaining backward compatibility with .pre-commit-config.yaml

@YazdanRa
Copy link
Contributor

YazdanRa commented Feb 6, 2026

Will there be a migration command in prek?
I would be more than happy to help add a migration command, if that's in the same direction as the vision.

@j178
Copy link
Owner Author

j178 commented Feb 6, 2026

It’ll be out by the end of the day :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants