Skip to content

jasim/legible-code

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Notes on Legible Code, for both humans and AI

This is a set of notes on what makes a codebase legible and habitable to me. It is written for both humans and AI.

This began as a collection of prompts I'd pass most frequently to coding agents for improving code quality. Undirected, agents tend toward code that looks great on the surface, but is structurally weak. These prompts help steer them closer to a shape I like.

What is Legible Code? Read the introduction

Install Skill

You can install this as a coding agent skill and use it to review code and to generate ideas to improve your architecture.

Please see Install Legible Code Skill

You should also read through the sources to get to the original authors of many of the ideas presented here.

License

MIT. See LICENSE.txt.

About

My subjective take on habitable code, for both humans and AI. Distilled from personal experience and the collected wisdom of practitioners I trust. Packaged as an Agent Skill that lets coding agents provide narrative commentary and structural design improvements for AI-generated code.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors