Skip to content

Adamska1008/explain-with-code

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 

Repository files navigation

Explain With Code

A small, general-purpose skill that makes project explanations cite concrete source code.

When a user asks an agent to explain a repository, feature, bug, architecture, file, module, function, API flow, or code path, this skill tells the agent to inspect the relevant files and support its explanation with file references, line numbers, and focused snippets.

What It Does

  • Grounds explanations in source code instead of broad summaries.
  • Requires concrete file and line references for important claims.
  • Encourages small, relevant snippets rather than large pasted blocks.
  • Separates verified source facts from inference when evidence is incomplete.
  • Keeps the answer readable by starting with the short answer, then anchoring details in code.

Contents

  • SKILL.md: the skill metadata and instructions.
  • LICENSE: the project license.

This repo intentionally keeps the skill minimal. There are no scripts, assets, references, or agent-specific UI metadata.

Install

Install the repository as a skill by placing it in a directory your agent runtime scans for skills.

For Codex, a symlink works well:

ln -s /path/to/explain-with-code ~/.codex/skills/explain-with-code

Restart the runtime after installing so it can refresh the available skills.

Update

Edit SKILL.md. If installed by symlink, changes in this repository are reflected in the installed skill path automatically.

Validate the skill with your runtime's skill validator when available.

About

A silent agent skill that grounds code-related conversations in source references and snippets.

Topics

Resources

License

Stars

Watchers

Forks

Contributors