Skip to content

aiskillstore/marketplace / skills/89jobrien/global-standards

global-standards

Verified

Project-wide coding standards and conventions specialist. Use PROACTIVELY when writing code, making architectural decisions, or establishing project conventions. Covers coding style, commenting, error handling, validation, tech stack consistency, and project conventions across all languages and frameworks.

FileKindSize
SKILL.mdskill md8.0 KB
references/coding-style.mdmarkdown1.2 KB
references/commenting.mdmarkdown1.1 KB
references/conventions.mdmarkdown1.6 KB
references/error-handling.mdmarkdown1.4 KB
references/tech-stack.mdmarkdown1.2 KB
references/validation.mdmarkdown1.2 KB
skill-report.jsonconfig19.8 KB

references/commenting.md

View on GitHub
---
author: Joseph OBrien
status: unpublished
updated: '2025-12-23'
version: 1.0.1
tag: skill
type: reference
parent: global-standards
---

# Commenting Standards

Guidelines for when and how to write code comments.

## When to Comment

### Do Comment

- Complex algorithms or business logic
- Non-obvious code decisions or workarounds
- Public APIs and interfaces
- Edge cases and known limitations
- Why code exists (not what it does)

### Don't Comment

- Obvious code that's self-explanatory
- Code that simply restates what's already clear
- Outdated or irrelevant information

## Comment Types

### Docstrings

- Function and class documentation
- Parameter descriptions
- Return value documentation
- Usage examples when helpful

### Inline Comments

- Explain complex logic
- Document workarounds
- Note important considerations

### TODO Comments

- Include context and rationale
- Link to issues when possible
- Include priority or timeline

## Best Practices

- Keep comments up to date
- Write comments that explain why, not what
- Use clear, concise language
- Remove outdated comments
receiving-code-reviewobra/superpowersUse when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative agreement or blind implementationStars: 322kUpdated Claude CodeCodexVerifiedInstall
requesting-code-reviewobra/superpowersUse when completing tasks, implementing major features, or before merging to verify work meets requirementsStars: 322kUpdated Claude CodeCodexVerifiedInstall
using-git-worktreesobra/superpowersUse when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallbackStars: 322kUpdated Claude CodeCodexVerifiedInstall
verification-before-completionobra/superpowersUse when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions alwaysStars: 322kUpdated Claude CodeCodexVerifiedInstall