source-command-polish

source-command-polish

Use this skill when the user asks to run the migrated source command polish.

Command Template

Polish Project

Make project professional, welcoming, and well-documented.

Scope

README:

• Clear project description (what, why, how)
• Installation instructions (tested)
• Quick start example (copy-paste ready)
• Key features (3-5 bullet points)
• API overview
• Links to full docs
• Badges (build status, coverage, version, license)
• Contributing guidelines link
• License

Documentation:

• API reference (all public functions)
• Usage examples (common scenarios)
• Tutorials (step-by-step guides)
• Architecture overview
• Troubleshooting guide
• FAQ
• Migration guides (if applicable)

Code Comments:

• JSDoc for public APIs
• Complex logic explained (WHY not WHAT)
• Non-obvious decisions documented
• Examples in comments where helpful

Packaging (package.json):

• Accurate description
• Relevant keywords (10-15)
• Repository URL
• Homepage URL
• Bug tracker URL
• Author info
• License
• Engines specified
• Files field (only ship necessary)

GitHub Metadata:

• Topics/tags (10-20 relevant tags)
• Description (concise, searchable)
• Website URL
• Social preview image (if applicable)

Changelog:

• Update CHANGELOG.md
• Clear version history
• Breaking changes highlighted
• Migration instructions

Contributing:

• CONTRIBUTING.md
• Code of conduct
• Development setup
• Testing guidelines
• PR process

Execution

1. Audit what exists vs what's missing
2. Update outdated content
3. Create missing documentation
4. Test all code examples
5. Verify all links work
6. Ensure consistency across docs

Quality Checks

• README explains project in <5 min read
• New user can get started in <10 min
• All examples tested and work
• No broken links
• Search-friendly keywords
• Professional presentation
• Beginner-friendly

Report: What was added/updated, coverage improved.