- Adding doc requirement to commit guidelines
Re: Adding doc requirement to commit guidelines
toggle quoted messageShow quoted text
Makes sense to me too.
Agree. It's an implicit requirement IMO, but I see people (sometimes me) forgetting it at both contribution and review time.
It’s come up a few times recently where new functions have been added without documentation, which makes them not very usable. Since it’s much easier to ensure that documentation gets
written if it’s done when the feature is added, I’d like to propose an update to our commit guidelines to say that new functions, language features, etc. need to have documentation included as part of the PR, and we don’t merge without that documentation.
What do others think?
Join email@example.com to automatically receive all group messages.