Enforce doc.go contracts and Russian doc-comments for exported Go symbols.
npx skills add https://github.com/pure-golang/level85 --skill x-doc-go
Please help me install this Agent Skill. Skill: x-doc-go Source: https://github.com/pure-golang/level85/tree/main/.agents/skills/x-doc-go Command: npx skills add https://github.com/pure-golang/level85 --skill x-doc-go
This Skill prevents Go packages from becoming hard to understand and risky to reuse by enforcing a consistent contract via doc.go, complete Russian doc-comments, and testable examples.
Ask the assistant to review or fix the target Go package by adding/updating doc.go and ensuring all exported symbols have proper Russian doc-comments, then run the doc.go smoke-check for that package directory.
High-intent search queries and answers about installing and using this skill.
Enforcing consistent Go package documentation requires adding a doc.go file to define the package contract, supported environment variables, and lifecycle constraints. This standardization prevents packages from becoming hard to understand and risky to reuse.
A standard doc.go file acts as a contract explaining what the package implements, how to create it, supported environment variables, and lifecycle constraints. It must contain a correct package comment and declaration structure.
You validate exported Go symbols by ensuring every exported type, function, and method has a full Russian doc-comment sentence ending with a period. An included smoke-check script can automatically validate this structure for a package directory.
Go Example tests are optional but encouraged when they clarify documented behavior or validate documentation snippets. Adding them keeps the package's documentation and runtime behavior in sync.
You cannot use this enforcement for command packages and mocks. The doc.go contract and Russian doc-comment rules explicitly exclude non-cmd and non-mocks Go packages from these mandatory documentation requirements.
GoogleDevRelExplorationsGenerate Go doc comments for exported symbols using a local AI model.
muratmirgunIdentify missing or weak godoc for exported Go APIs and examples.
samberConfigure and run golangci-lint to analyze Go projects and interpret results.
HadiCherkaouiStandardize Go doc comments, package docs, and godoc formatting.
