coding-guidelines
/coding-guidelines
Keep code comments concise and function signatures simple when writing, editing, or reviewing code. Use for a focused pass that removes redundant, verbose, or historical comments and multi-value returns from a diff.
- Author
- smartcontractkit ↗
- Repository
- chainlink-ccip-solana ↗
- Licence
- MIT
- Last repository change
- 13.11.2026
Assessment and security
- Files in this package
- 1
- Scripts
- 0
- HTML comments
- 0
- URLs in SKILL.md
- 0
No signals detected. Repository changed on 13.11.2026, without references to retired models or APIs.
MIT, open: use and modify while retaining author attribution.
What it does and when to use it
Keep code comments concise and function signatures simple when writing, editing, or reviewing code. Use for a focused pass that removes redundant, verbose, or historical comments and multi-value returns from a diff.
Original author description
Keep code comments concise and function signatures simple when writing, editing, or reviewing code. Use for a focused pass that removes redundant, verbose, or historical comments and multi-value returns from a diff.
How it works
SKILL.md has no level-two headings · 20 lines, 258 words
SKILL.md preview
--- name: coding-guidelines description: Keep code comments concise and function signatures simple when writing, editing, or reviewing code. Use for a focused pass that removes redundant, verbose, or historical comments and multi-value returns from a diff. --- # Comment discipline When writing or changing code: - Prefer clear names and structure to explanatory comments. Add a comment only if a reader would miss an important fact from the code and nearby types. - Explain current invariants, security boundaries, protocol requirements, or surprising behavior. State the reason directly and briefly. - Never describe the development journey: previous implementations, bugs that led to the change, review discussion, or claims about what the code "now" does. Put that context in the PR description. - Do not link Jira tickets or internal issue trackers in code comments. - Avoid comments that paraphrase the next line, justify a naming choice with counts or anecdotes, or use a paragraph for a local detail. - Preserve required license headers, public API documentation, and useful existing comments. Do not remove a comment that explains a real constraint merely to shorten the file. Before finishing, scan added and edited comments in the diff. Delete or shorten any comment that fails these rules; if the code is clear without it, delete it. # Function signatures - Do not return many values separated by commas. Beyond a value plus `error` or an `ok` bool, return a named struct so call sites read by field and never by position (avoid shapes like `a, _, _, b, ok := f()`). - Prefer pointer fields (`nil` = absent) over a companion bool, such as `add *Ref` instead of `ref Ref, add bool`. - When a function has many parameters of the same type, group them into an input struct.
Versions
| Repository | Score | Licence |
|---|---|---|
| This page · smartcontractkit/chainlink-ccip-solana | 90 | MIT |
| tech-leads-club/agent-skills | 100 | MIT |
| ajitta/karpathy-regula | 100 | MIT |
| ScotterMonk/AgentAutoFlow | 100 | CC0-1.0 |
| dennisdoomen/skills | 96 | MIT |
| k1-c/linear-tui | 95 | MIT |
Database snapshot: 13.11.2026 · package version 2a21849532d8 (SHA-256 digest of the entire package)
Downloads in the last 30 days: 0 · ranking
Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.
Similar skills
- 100code-comments
Write, review, or remove code comments. Use when adding comments or doc comments, reviewing the comments in a diff, or cleaning up or removing comments. - 95writing-code
Use when writing or editing implementation code — any change that adds, modifies, or removes logic, signatures, or comments on the lines being written. Also covers reviewing, cleaning up, or improving the comments on code being edited. Do NOT activate for test files and their… - 100comment-cleanup
This skill should be used when the user asks to "clean up comments", "remove superfluous comments", "remove redundant comments", "trim verbose comments", "remove changelog comments from code", "clean up the README", or "run a comment cleanup" on a set of files or directories, or… - 100code-comment-style
Write and tighten code comments so they state the why or the invariant in 1-3 lines. Use when adding comments to code, or when pruning verbose comments in a diff or PR. - 100code-comments
Write clear, plain-spoken code comments and documentation that lives alongside the code. Use when writing or reviewing code that needs inline documentation—file headers, function docs, architectural decisions, or explanatory comments. Optimized for both human readers and AI… - 100review-guidelines
Review code changes for compliance with CLAUDE.md guidelines. Use when the user says 'review guidelines', 'check guidelines', or 'validate against guidelines'.