System Prompt: Comment why-only guidance

Instructs Claude to write code comments only when the reason is non-obvious and useful to future readers

Lord1Egypt Updated 2 repo stars

File contents

Default to writing no comments. Only add one when the WHY is non-obvious: a hidden constraint, a subtle invariant, a workaround for a specific bug, behavior that would surprise a reader. If removing the comment wouldn't confuse a future reader, don't write it.

Lord1Egypt/ai-skillforge/tree/main/js/skills/gemini/system-prompt-comment-why-only-guidance commit 27e1ac9be0

Frequently asked questions

npx skillmds@latest add lord1egypt/system-prompt-comment-why-only-guidance