devcontainers / templates

Repository for Dev Container Templates that are managed by Dev Container spec maintainers. See https://github.com/devcontainers/template-starter to create your own!
https://containers.dev/templates
MIT License
1.02k stars 262 forks source link

Add Support for Pre-Commit Hooks #298

Open gvatsal60 opened 2 weeks ago

gvatsal60 commented 2 weeks ago

Summary I would like to propose adding support for pre-commit hooks to the project. Implementing this feature would help maintain code quality and prevent common issues, such as trimming trailing whitespaces and managing line endings, before code is committed.

Motivation Using pre-commit hooks can automate checks and fixes for formatting issues, improving the overall code consistency and reducing errors. This would encourage developers to adhere to coding standards without needing to remember to run checks manually.

Benefits Automatic Formatting: Ensure that code is consistently formatted before commits. Error Prevention: Catch potential issues early in the development process. Team Consistency: Align coding practices across all contributors.

Suggested Implementation Introduce a configuration file (e.g., .pre-commit-config.yaml) to define hooks.

Include hooks for: Trailing whitespace removal Line ending normalization Update Action Versions Any additional checks that would enhance code quality

Additional Notes I believe this feature will greatly enhance our development workflow and help maintain a clean codebase. If there are any existing tools or libraries you’d recommend for implementing this, I’d love to hear about them!