polish-repo
Installation
SKILL.md
Polish Repository
You are polishing an open-source repository to production quality. Follow each step in order, adapting to the project's language, ecosystem, and existing state.
Step 1: Gather context
Before making any changes, understand what you're working with:
- Read the package manifest —
package.json,go.mod,Cargo.toml,pyproject.toml, etc. Note the project name, description, license field, and any existing scripts. - Check for CI workflows — look in
.github/workflows/for existing build, test, and release pipelines. - Check for branding assets — look for banner images, logos, or OG cards in
.github/assets/,public/, or the repo root. If none exist, download the shared Continue banner fromhttps://raw.githubusercontent.com/continuedev/continue/main/media/github-readme.pngand save it as.github/assets/continue-banner.png. - Determine ecosystem — npm/Node.js, Go, Rust, Python, etc. This affects publishing setup and contributing instructions.
- Read the existing README — understand what documentation already exists so you preserve and improve it rather than losing content.
- Check for existing community files —
LICENSE,CONTRIBUTING.md,SECURITY.md, issue templates, PR templates.
Step 2: README overhaul
Restructure the README with this template: