unhack: add pre-commit guidelines (#19617)

This commit is contained in:
Semir Patel 2023-11-15 10:57:40 -06:00 committed by GitHub
parent da8700f216
commit 4f929f8ff5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 4 deletions

View File

@ -3,14 +3,29 @@
# See https://pre-commit.com for more information # See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks # See https://pre-commit.com/hooks.html for more hooks
#
# Opt-in to running pre-commit hooks by running `make tools`.
#
# Guidelines for adding new pre-commit hooks
# ====================================================================
# A hook SHOULD be blazingly fast (<2s) to impose minimal latency on
# developer workflows (e.g. golangci-lint takes > 8s)
#
# A hook SHOULD attempt to fix errors, not just identify them.
#
# A hook SHOULD address common errors in files that tend to change
# frequently. While surfacing esoteric issues is nice, hooks that have a
# wider impact are preferred.
#
repos: repos:
- repo: https://github.com/tekwizely/pre-commit-golang - repo: https://github.com/tekwizely/pre-commit-golang
rev: v1.0.0-rc.1 rev: v1.0.0-rc.1
hooks: hooks:
# Formats go imports into deterministic sections # Formats go imports into deterministic sections.
# `pre-commit run gci` to run in isolation # `pre-commit run gci` to run in isolation.
- id: my-cmd - id: my-cmd
name: gci name: Format go imports
alias: gci
# skip all generated go files # skip all generated go files
exclude: | exclude: |
(?x)( (?x)(