Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve pre-commit hook and docs #1774

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve pre-commit hook and docs #1774

wants to merge 1 commit into from

Commits on Feb 3, 2022

  1. Improve pre-commit hook and docs 

    * Add the `description` field that will appear on https://pre-commit.com/hooks.html (I’m about to submit it).
* Describe what pre-commit does a little more.
* Describe the `pre-commit autoupdate` step required to pin to a specific version rather than `master`. Using `master` could be broken, and isn't reproducible between environments. Indeed pre-commit warns if you use `master`:

  ```
  [WARNING] The 'rev' field of repo 'https://github.com/standard/standard' appears to be a mutable reference (moving tag / branch).  Mutable references are never updated after first install and are not supported.  See https://pre-commit.com/#using-the-latest-version-for-a-repository for more details.  Hint: `pre-commit autoupdate` often fixes this.
  ```
    @adamchainz
    adamchainz committed Feb 3, 2022
    Configuration menu
    Copy the full SHA
    33e19b2 View commit details
    Browse the repository at this point in the history