Provide best practices for writing durable source comments.
npx skills add https://github.com/danielraffel/burl --skill code-comments-danielraffel
Please help me install this Agent Skill. Skill: code-comments Source: https://github.com/danielraffel/burl/tree/main/.agents/skills/code-comments Command: npx skills add https://github.com/danielraffel/burl --skill code-comments-danielraffel
This Skill provides guidance on writing clear, lasting comments that improve code readability and maintainability.
Run the skill and follow the guidelines for writing comments in your codebase.
High-intent search queries and answers about installing and using this skill.
Best practices for code documentation recommend rewriting non-durable comments to explain code invariants, non-obvious decisions, and external constraints. This approach avoids process provenance and speculative future roadmaps.
To write valuable code comments, focus on explaining non-obvious decisions and external constraints rather than process provenance. This skill provides rewrite examples to convert non-durable comments into valuable ones.
You should add comments to improve code maintainability when the code involves invariants, non-obvious decisions, or external constraints. This skill offers guidelines on when and what to comment to enhance clarity.
Best practices for naming tests recommend using descriptive and clear naming conventions. This skill provides specific standards to ensure test names clearly communicate their purpose and maintainability.
Rewrite non-durable comments by removing process provenance and speculative roadmaps, focusing instead on code invariants and external constraints. The skill provides specific rewrite examples to convert comments into valuable documentation.
sammcjCreate CLAUDE.md files with XML-style sections documenting non-obvious codebase context.
jie023Enforce Alibaba Java coding style and naming conventions across a codebase.
zerobias-orgEnforce concise code comment rules for JSDoc and TODO tracking.
tsurutanGenerate inline and standalone documentation from JavaScript, TypeScript, Python, and Go code.
