Agent skill
readme-review
Review the project README to understand what it does and suggest a recommended next step. Use when starting work on an unfamiliar project.
Install this agent skill to your Project
npx add-skill https://github.com/sofer/.agents/tree/main/skills/readme-review
SKILL.md
README review
Quickly orient yourself in a new project by reviewing the README and suggesting what to do next.
Process
Step 1: Find and read the README
- Look for README files in the project root (README.md, README, README.txt, readme.md)
- Read the README content thoroughly
- If no README exists, note this and scan the project structure instead
Step 2: Provide a summary
Write a concise summary covering:
- Purpose: What does this project do? (1-2 sentences)
- Tech stack: Key languages, frameworks, and tools
- Status: Active development, maintenance mode, or unclear
- Setup: How to get started (if documented)
Keep the summary brief and focused on essentials.
Step 3: Recommend a next step
Based on the project context and README content, suggest ONE recommended next action. Consider:
For new/unfamiliar projects:
- If requirements are unclear: suggest
/intentto clarify goals - If there's a backlog or issues list: suggest reviewing it
- If setup instructions exist: suggest running the project locally
For projects with clear direction:
- If there's a documented contribution guide: point to it
- If tests exist: suggest running them to verify the setup
- If there's a clear next feature or bug: suggest starting there
For projects lacking documentation:
- Suggest creating or improving the README
- Suggest using
/requirementsto document what exists
Output format
## Project summary
[Brief summary of what the project does]
**Tech stack:** [languages, frameworks, tools]
**Status:** [development stage or activity level]
## Recommended next step
[One clear recommendation with rationale]
To proceed: [specific command or skill to invoke, if applicable]
Tips
- Keep it short; this is orientation, not deep analysis
- Be honest if the README is sparse or unclear
- Tailor recommendations to what the user might actually want to do
- Reference specific skills (e.g.,
/intent,/requirements,/orchestrate) when they fit
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
meeting-context
Determine why a meeting is happening and what should be discussed
reconcile
Analyse and resolve divergences between SDLC manifest and actual development state (git commits, branches, uncommitted files). Use when manifest and reality have drifted apart, or before picking next story to ensure clean state.
init-override
Create a symlink from AGENTS.md to CLAUDE.md in the current project directory. Use when the user wants to initialise a project to use AGENTS.md as the memory file instead of CLAUDE.md.
commit
Git workflow operations with Conventional Commits. Supports subcommands - branch (create feature branch), commit (stage and commit changes), pr (create pull request), merge (merge PR). Automatically available when the current directory is a git repository. Use when user needs git operations during development workflow.
contact-research
Research a person given their name and email, returning a brief profile with role, company, LinkedIn summary, and previous interactions
design
Plan architecture and components for a single user story. Use after spec phase to create a technical design before implementation. Produces design documents that guide stubs and implementation.
Didn't find tool you were looking for?