Skip to content

Repository files navigation

Code readability skills

Agent skills for reviewing and improving code readability. They cover principles, naming, comments, state, functions, dependencies, and code review.

The skills adapt Munetoshi's Code Readability presentations into concise instructions that coding agents can apply while working on a codebase.

Installation

Clone the repository:

git clone https://github.com/ricky9667/code-readability-skills.git

Copy every code-readability-* directory into the user-level or project-level skills directory used by your coding agent:

cp -R code-readability-skills/code-readability-* /path/to/your-agent/skills/

The exact destination depends on the agent. These skills work with coding agents that support the SKILL.md format. You can copy a single directory if you only need one skill. Start a new agent session after installation so the skills are discovered.

Reference

Skill Focus
code-readability-principles Foundational readability principles
code-readability-naming Accurate and unambiguous names
code-readability-comments Comments that explain intent
code-readability-state Explicit state and valid transitions
code-readability-function Focused functions with clear flow
code-readability-dependency-i Coupling between components
code-readability-dependency-ii Dependency direction and cycles
code-readability-review Focused, intent-aware code reviews

Each skill links to its corresponding English presentation. The original source index also includes the Japanese presentations and related material.

License

This repository is available under the MIT License. The original presentation material belongs to its respective author and remains subject to its own terms.

About

Agent skills for reviewing and improving code readability. Referenced from Munetoshi's Code Readability presentations.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors