Add optional pre-commit hooks for local contributor checks

[MUFFANUJ]

What would you like to be added:
Add an optional pre-commit configuration to the repository, along with documentation on how contributors can enable it locally.

Why is this needed:
This would provide contributors with fast, local feedback for formatting, linting, and basic checks before creating commits, helping catch simple issues early. Making it optional ensures it does not introduce friction or block contributors who prefer not to use it, while still offering a convenient quality-of-life improvement for those who do.

[MUFFANUJ]

if this issue seems a needed one will add a PR to implement the same :)

[shivansh-gohem]

Hey @MUFFANUJ, great idea! This would definitely help catch small errors before pushing.

Just a suggestion when you implement this: maybe start with lightweight hooks like trailing-whitespace, end-of-file-fixer, and check-yaml. If you add heavy linters right away, it might make commits feel too slow for some people.

[eeshaanSA]

Hey @MUFFANUJ, can you please tell us briefly what pre-commit hooks you plan to add, how, and how would they help?

[MUFFANUJ]

I’m thinking of starting with a very small and lightweight set of pre-commit hooks that give quick feedback without getting in anyone’s way. The key ones would be trailing-whitespace and end-of-file-fixer to keep diffs clean, check-yaml and check-json to catch broken config files early (especially for CI), and check-merge-conflict to avoid accidentally committing unresolved merge markers. All of these run very fast, don’t enforce opinionated formatting, and help maintain basic repo hygiene while staying completely optional for contributors.

[MUFFANUJ]

And i would love to work on this can you please assign this to me if this looks good

[eeshaanSA]

Okay, sure. You can start with pre commit hooks for .md files only first. We can improvise from there.

[MUFFANUJ]

sure thanks :)