skills.rest
Generous-Corp
Generous-CorpOFFICIAL
Explore all skills by this author →
GitHub

code-comments

Remove transient process-based breadcrumbs and enforce invariant-focused comments in source code.

13|1|Updated Apr 6, 2026
Search Tags:#code review#linting#documentation#clean code#maintenance#hygiene
One-click install
npx skills add https://github.com/Generous-Corp/pulp --skill code-comments-generous-corp
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-comments
Source: https://github.com/Generous-Corp/pulp/tree/main/.agents/skills/code-comments
Command: npx skills add https://github.com/Generous-Corp/pulp --skill code-comments-generous-corp

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill eliminates stale, process-heavy, and non-durable comments that clutter the codebase, ensuring that documentation remains relevant and useful for future maintainers.

Core Features & Use Cases

  • Comment Hygiene: Provides clear guidelines on what to remove (e.g., phase labels, PR breadcrumbs) and what to keep (e.g., invariants, non-obvious "why").
  • Durable Documentation: Encourages writing present-tense, stable statements about code behavior rather than transient project history.
  • Use Case: Use this skill when reviewing a pull request to identify and remove "breadcrumb" comments like phase labels or issue numbers that don't explain the underlying code logic.

Quick Start

Run the code-comments skill to audit your current diff for stale provenance and non-durable documentation markers.

Frequently Asked Questions about code-comments

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I remove stale code comments and PR breadcrumbs during a code review?▼

To remove stale code comments during a code review, audit your diff for transient process-based breadcrumbs like phase labels and issue numbers, then enforce durable, present-tense statements that explain non-obvious code logic and invariants.

What makes source code documentation durable and maintainable for external contributors?▼

Durable source code documentation uses present-tense, stable statements to describe code behavior and invariants rather than transient project history, ensuring long-term maintainability and clarity for external contributors.

How do I enforce clean code comment standards and linting rules across a repository?▼

Enforce clean code comment standards by applying specific linting rules to all source files within the repository, requiring present-tense descriptive standards for new and existing comments to ensure consistent hygiene.

When should I keep or remove comments explaining code logic in my codebase?▼

Keep comments explaining non-obvious code logic and invariants, and remove transient breadcrumbs like phase labels or issue numbers that do not explain the underlying code behavior to ensure long-term maintainability.

Can I audit a pull request diff for non-durable documentation markers?▼

Yes, you can audit a pull request diff for non-durable documentation markers by checking for stale provenance, transient breadcrumbs, and process-heavy comments that clutter the codebase rather than explaining code logic.

Related Skills

Explore More Software Engineering Skills→
ather-techieather-techie
6

check-feature-docs

Audits git repository changes to ensure documentation files are updated.

Community
Intermediate
t-stringst-strings

Global Validation

Enforce centralized validation standards across repository code and CI pipelines.

Official
Basic
eliottbusinesseliottbusiness

requesting-code-review

Automate pre-commit code review with static analysis and security scanning.

Community
Advanced
motlinmotlin
14

comment-cleanup

Remove unnecessary or outdated comments from source files.

Community
Basic