Go Documentation

Use when writing or reviewing Go documentation — godoc comments on packages, types, functions, methods, sentinel errors; runnable Example tests; README/CONTRIBUTING/CHANGELOG. Covers the project-type detection (library vs application) that decides which docs are needed, comment grammar (start with name, full sentences), what to document vs what to skip, and Example test conventions. Apply proactively when introducing exported names, even if documentation was not requested.

muratmirgun Updated 9 repo stars

File contents

muratmirgun/gophers commit a3c63a404a

Frequently asked questions

npx get-skill add muratmirgun/go-documentation