Is it reasonable to require all contributed code has godoc?

[geoknee]

https://go.dev/blog/godoc

I feel like this would be a good "rule" to try and stick to. I'm not sure if there any linters or tools (other than godoc) that could help us stick to the rule.

We could add a checkbox to the PR template for this repository.

[NiloCK]

In a word: yes.

Notable:

Godocs exist also at the level of struct fields and interface methods.

These comments are discoverable in-editor, but as far as I can tell are NOT exposed / exported as part of the generated package documentation.

I think a good minimum rule is that all godoc comments which WILL be output as generated documentation (comments adjacent to package-scoped identifiers) should exist.