Skip to content

kengz/good-code

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 

Repository files navigation

good-code

Agent instructions and coding standards built on The 6 Principles: Consistent, Correct, Clear, Concise, Simple, Salient.

Framed for code — this repo is good-code — but medium-agnostic: the same six principles govern good writing, documentation, and design just as well.

Install as Agent Skill

npx skills add kengz/good-code

This installs the good-code skill, which generates a project-specific CLAUDE.md (or AGENTS.md) tailored to your stack. Works with 37+ agents — Claude Code, Cursor, Codex, Copilot, and more.

Use Directly

Copy skills/good-code/CLAUDE.md into your project root and adapt the comment blocks to your stack.

What's Included

File Purpose
PRINCIPLES.md The 6 Principles — full explanations
CLAUDE.md Agent instructions template
SKILL.md Skill definition — auto-detects your stack and generates a tailored instructions file

The 6 Principles

  1. Consistent — Design from first principles — unified naming, patterns, and conventions throughout.
  2. Correct — Constructed from known truths, not debugged into shape.
  3. Clear — Says what it does — intent is obvious from naming and logic alone.
  4. Concise — Simplified to the essence — nothing left to remove.
  5. Simple — Few moving parts, easy to explain, cheap to maintain — complexity is not sophistication.
  6. Salient — Essential enough to be used widely, fundamental enough to last.

Read the full writeup in PRINCIPLES.md.

About

Principles of good code design

Resources

Stars

2 stars

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors