Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Concise Comments

An Agent Skill for keeping code comments minimal and high-signal. It teaches coding agents to remove comments that narrate visible code while preserving rationale, constraints, tradeoffs, required directives, and other information the code cannot express.

The skill follows the open Agent Skills specification and works with both OpenAI Codex and Claude Code.

Install

Codex

npx skills add noah4520/concise-comments --skill concise-comments --global --agent codex --yes

Claude Code

npx skills add noah4520/concise-comments --skill concise-comments --global --agent claude-code --yes

Both commands install the skill globally. For a project-local installation, omit --global.

Use

Codex and Claude Code can activate the skill automatically during code authoring, implementation, refactoring, debugging, and review tasks that may add or touch comments.

Codex

Use $concise-comments to review the comments in this diff.

Claude Code

/concise-comments Review the comments in this diff.

What it enforces

  • Delete comments that restate names, types, assignments, or visible control flow.
  • Keep rationale, constraints, tradeoffs, warnings, and non-obvious operational facts.
  • Prefer clearer code when a name or structure can replace narration.
  • Keep required directives, legal notices, generated-file markers, and mandated API documentation.
  • Avoid arrow-style prose, label-heavy comments, parenthetical pile-ups, and code-level ticket references.
  • Keep TODOs, commit subjects, and short change summaries direct.

Repository layout

skills/concise-comments/
├── SKILL.md
└── agents/
    └── openai.yaml

SKILL.md is the cross-agent source of truth. agents/openai.yaml adds optional Codex UI metadata and is safely ignored by other compatible agents.

Validate

npm test

The validation checks the portable frontmatter, naming constraints, unresolved placeholders, and Codex UI metadata.

Design references

This repository follows the common structure and progressive-disclosure guidance from:

License

MIT

About

A portable Agent Skill for minimal, high-signal code comments.

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages