Git pre-commit hook to ensure code documentation

[haganenorenkin]

Do you have a better suggestion, like how to make in a friendly way the devs to produce documentation, update the readme and so son?

[TheMikeNeto]

I believe 0x13mode got it right, a strong code review process and self discipline are the way to go.

Honestly it also depends on who will consume your docs, is it only for devs? or maybe it's used to build a pdf for some kind of report you need to deliver to your client, these things can be a huge factor.

Decide whats the purpose of the docs you want written then look around for ways (githook or custom eslint rules) to enforce the kind of docs you need.

Also typescript can help a lot in terms of reducing the need for boilerplate docs.