Open Source Project Polish — Development skill for Claude Code

English | [简体中文](README.zh-CN.md)

Open Source Project Polish

An agent skill that turns any project folder into a polished, publish-ready open source repository — **without touching your source code**.

[](LICENSE) [](SKILL.md) [](CONTRIBUTING.md)

What it does

`open-source-project-polish` is a [skill](SKILL.md) for AI coding agents (Claude Code and compatible harnesses). Point it at a project folder and it brings the repository up to open source standards by adding and improving **only** project-facing metadata and documentation:

• A clear, attractive README (with an optional bilingual English/Chinese pair).
• Community health files: LICENSE (MIT by default), CONTRIBUTING, CODE_OF_CONDUCT, SECURITY, SUPPORT, CHANGELOG, CITATION.
• GitHub scaffolding: issue/PR templates, badges, .gitignore, .gitattributes, .editorconfig.
• Git/GitHub setup: initialize git if missing, run a secrets check, create a public remote, and push the documentation-only changes.

It is deliberately conservative: it polishes the *outside* of your project and leaves the *inside* exactly as you wrote it.

What it will not do

• Modify product/source code, tests, notebooks, assets, or runtime behavior (unless you explicitly ask).
• Leak machine-specific local paths (e.g. /home//...) into public docs.
• Invent release history, fake commands, or untruthful badges.
• Push to a remote when a secrets/private-data check fails.

See the full contract in [SKILL.md](SKILL.md#hard-boundaries).

Installation

This skill is a single self-contained folder (`SKILL.md`). Install it into your agent's skills directory.

**Option A — `npx skills` (recommended):**

npx skills add OpenGHz/open-source-project-polish

**Option B — manual:**

#