opentelemetry.io icon indicating copy to clipboard operation
opentelemetry.io copied to clipboard

[CI/CD] Set up git pre-commit and other hooks to make for a smoother contributor experience

Open chalin opened this issue 1 month ago • 3 comments

@open-telemetry/docs-maintainers - to help all contributors, us included, I'd like to suggest that we setup Git hooks, in particular pre-commit hooks. We can help enforce those using https://github.com/typicode/husky. WDYT?

Tasks

  • [ ] Prep: #8314 -- sets up scripts for opting in
  • [ ] ...

chalin avatar Nov 01 '25 15:11 chalin

with #8314 merged this is in place already?

what's missing is the documentation on how one can opt into it, right?

svrnm avatar Nov 19 '25 11:11 svrnm

No it is not in place. I was waiting for a thumbs up before doing the next step of setup. But first we need to agree (or not) to use husky. I'd suggest we do, it's small and will make it easy for contributors to opt-in. Eventually, if it works well enough, we can make it opt-out. Thoughts?

chalin avatar Nov 19 '25 13:11 chalin

I am happy to have that and happy to opt-in!

svrnm avatar Dec 10 '25 07:12 svrnm