dneprokos/readme-polisher
.cursor/skills/readme-polisher/SKILL.md
Create or improve a repository README using verified project details. Use this skill when the user asks to polish a repo, add badges, explain setup, improve first impressions, or generate a concise project overview with optional diagrams. Prefer accurate, evidence-based documentation and skip anything you cannot confirm from the codebase.
$ install --global
skillsauthnpx skillsauth add dneprokos/skills-examples readme-polisherInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 24, 2026, 8:50 PM1.8s1 file scanned
SKILL.md
- name:
- readme-polisher
- description:
- >-
- argument-hint:
- project path or repo context
README Polisher
Build a README that is clear, practical, and tailored to the repository.
When this skill fits
Use it for requests like:
- "improve my README"
- "make this repo look more professional"
- "add badges and quick start steps"
- "generate a README for this project"
Do not use it for:
- API reference generation
- changelog writing
- release notes
- CI/CD setup
Workflow
1. Inspect the project first
Gather facts from files such as README.md, package.json, pyproject.toml,
Cargo.toml, go.mod, .github/workflows/*, and license files.
If shell access is available, run:
pwsh -NoProfile -File ./.github/skills/readme-polisher/scripts/scan_project.ps1 <project-path>
Use the scan results as a starting point, then sanity-check important details.
2. Load the writing guidance
Read references/readme-guidelines.md before drafting. It covers section order,
tone, proportionality, and common documentation mistakes.
3. Start from the template
Use assets/readme-template.md as a scaffold. Replace every placeholder with
real information. Remove any section that does not help this project.
4. Add only verifiable badges
Check assets/badges.json for badge patterns. Include badges only when the
underlying metadata exists. No fake versions, broken build badges, or guessed
social links.
5. Keep it proportional
- Small utility: short overview + usage is enough
- Library: install, example, and API entry points
- App/service: setup, configuration, and run steps
- Monorepo: explain packages and add a diagram only if it helps
6. Validate before finishing
Confirm that:
- commands are real
- no placeholders remain
- section titles are relevant
- links resolve or are clearly marked as local
- tone matches the project rather than sounding generic
7. Optional diagram
If the repo has multiple moving parts, adapt a Mermaid starter from
assets/diagram-ideas.md. Skip diagrams for simple repos.
Hard rules
- Never invent package names, releases, CI status, or contact links
- Prefer concise and useful wording over hype
- Preserve important existing instructions if the current README already has them
- If details are missing, say less instead of guessing
Related Skills
dneprokos/windows-secretmanagement-setup
data-ai
VerifiedTrustedCommunity
Install and configure Windows Credential Manager style secret storage for PowerShell using SecretManagement and SecretStore. Use when users ask to install secret manager support, set up Credential Manager for GitHub token storage, or bootstrap GitHubToken for PR skills.
2SKILL.mdUpdated Apr 16, 2026
dneprokos/ut-coder
development
VerifiedTrustedCommunity
Generate a complete, compilable unit test file from an Analyst test plan and Architect strategy. Uses AAA pattern, language-specific frameworks (NUnit, JUnit 5, pytest, Vitest), correct mock/real dependency instantiation, constructor null-guard tests, parameterized tests, and setup/teardown hooks. Input is the Analyst JSON plan plus Architect strategy summary. Use when asked to generate test code, write test implementation, create test file, or implement tests from a plan. Also invoked as Phase 3 by the unit-test-generator agent.
2SKILL.mdUpdated Apr 16, 2026
dneprokos/ut-architect
development
VerifiedTrustedCommunity
Define the mocking strategy and assertion style for a unit test plan. Classifies each dependency as mock or real, resolves assertion framework and test file location from project patterns, lists constructor null-guard tests with expected exception types, and specifies abstraction interfaces for non-deterministic calls. Input is a JSON test plan from ut-analyst. Use when asked to define mocking strategy, plan test architecture, classify dependencies as mock vs real, or design test structure. Also invoked as Phase 2 by the unit-test-generator agent.
2SKILL.mdUpdated Apr 16, 2026
dneprokos/ut-analyst
testing
VerifiedTrustedCommunity
Analyze a class or function and produce a structured JSON test plan. Classifies all dependencies (interface, abstract, valueObject, dto, primitive), detects non-deterministic calls, enumerates test cases using black-box techniques (Equivalence Partitioning, Boundary Value Analysis, Decision Table, State Transition), and lists constructor null-guard requirements. Use when asked to analyze a class for testing, create a test plan, classify dependencies, or produce test case inventory. Also invoked as Phase 1 by the unit-test-generator agent.
2SKILL.mdUpdated Apr 16, 2026