From mr-sparkle
User's README style preferences — ultra-terse, action-focused, <50 lines. Use when writing or reviewing any README file.
How this skill is triggered — by the user, by Claude, or both
Slash command
/mr-sparkle:readme-styleThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
User preferences and corrections for writing READMEs. Claude knows how to write READMEs; this documents what makes THIS user's style different.
User preferences and corrections for writing READMEs. Claude knows how to write READMEs; this documents what makes THIS user's style different.
Ultra-terse: ~20-50 lines is ideal. Never more than 100 Action-focused: Show commands with inline comments, minimal prose No fluff: Skip troubleshooting, file structure, version history
# Project Name
One-liner description.
## Overview
- What it does (bullet 1)
- What it does (bullet 2)
## Skills
Setup
```
/plugin:setup # walks through configuration
```
Main Actions
```
/plugin:do-thing # does the thing
/plugin:do-thing with args # does the thing with these args
/plugin:do-other selective stuff # does other with just the selective stuff
```
Key characteristics:
# commentsInclude ONLY:
# comments explaining each commandExclude ALL of these common README elements:
# Development Workflow Plugin
Comprehensive tooling for Git and GitHub workflows with intelligent automation.
## Features
This plugin provides:
- **Smart Git Operations**: Streamlined commit workflows with automatic formatting
- **GitHub Integration**: Seamless PR creation and issue management
- **Workflow Automation**: Pre-commit hooks and quality checks
## Components
### Agents
- `pr-creator` - Creates pull requests with proper formatting
- `commit-helper` - Assists with commit message formatting
### Skills
- `git-workflow` - Documents git workflow preferences
- `github-workflow` - GitHub interaction patterns
### Commands
- `/pr` - Create pull request
- `/commit` - Smart commit with formatting
## How It Works
The plugin integrates with your local git repository to provide enhanced
workflow capabilities. It uses the GitHub CLI when available and falls back
to the GitHub MCP server for API operations...
[... continues for 50+ more lines ...]
Issues:
# DMV
Git and GitHub workflow preferences for Claude.
## Overview
- Tells Claude the user's commit message format (terse, no emojis, no attribution)
- Tells Claude to prefer gh CLI over GitHub MCP when available
- Documents pre-commit hook retry logic (edge case handling)
## Commands
Setup
```
/dmv:setup # walks through git and GitHub configuration
```
Main Actions
```
/pr # create pull request from current branch
/pr --draft # create draft pull request
/commit "message" # commit with user's preferred format
/github:issue <number> # fetch and analyze issue
```
Pattern:
Group Label
```
/command # what it does
/command with args # what it does with args
/command:subcommand # what the subcommand does
```
Details:
Setup, Main Actions, Analysis# comments right-aligned (use spaces to align)If you see these in a README draft, flag for removal:
Standard README approach:
Explain what it does → List features → Document components → Show examples
Our approach:
One-liner → 2-3 bullets → Commands with comments → Done
npx claudepluginhub racurry/neat-little-package --plugin mr-sparkleGenerates human-focused README files for projects. Activates on 'write README', 'create README', 'update README'.
Guides creation and improvement of README files for open-source or software projects. Follows community best practices for structure, badges, and quick-start sections.
Crafts production-grade README.md files with hero sections, TL;DR, quick starts, comparison tables, troubleshooting, and limitations. Use for project docs, README writing, or open source setup.