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.

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

Adding a Base Configuration for Pre-commit Hooks #49

Open
longnd opened this issue Jun 5, 2024 · 0 comments
Open

Adding a Base Configuration for Pre-commit Hooks #49

longnd opened this issue Jun 5, 2024 · 0 comments

Comments

@longnd
Copy link
Contributor

longnd commented Jun 5, 2024

Why

pre-commit along with its pre-defined hooks, are helpful to perform certain operations before each commit, which help to catch the issues early and avoid wasting CI time. It includes (but not limited to) the following steps:

  • Trimming trailing whitespace
  • Ensuring files end with a single newline
  • Preventing large files from being committed
  • Verifying the syntax of YAML files
  • Detecting and blocking hardcoded secrets
  • And more...

By adding some default pre-config hook configurations to the git template, it can be applied to future projects

Who Benefits?

  • The development team, who doesn't need to waste time on fixing those issues on the PRs
  • The CI cost
@longnd longnd changed the title Add Pre-commit-hooks base configuration Adding a Base Configuration for Pre-commit Hooks Jun 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant