prompts.chatprompts.chatprompts.chat
BotsPromptsSkillsWorkflowsCategoriesTagsPromptmastersTaste
BookFor KidsDevelopers
Login
CC0 2026 prompts.chat
DeepWikiHow to...DocsAPIPrivacyTermsSupportAboutGitHub

Code Comments

G
@grantcarthew
5 months agoMay 27, 2026 at 06:13 AM

Content

## Code Comments

- Default to no comment; add one only when the WHY is non-obvious and cannot be re-derived from the code
- Do not restate WHAT, name the identifier, or paraphrase the next line
- Do not write file-layout maps, roadmap or future-work notes, ticket/PR/caller references, or conversation references ("as discussed", "per the design doc")
- Preserve godoc form on exported Go symbols (`// Name verbs ...`); non-obvious WHY goes in subsequent sentences
- Put deep rationale in the commit body, not in source or a parallel doc

Comments (0)