skills.rest
onblueroses
onbluerosesCOMMUNITY
Explore all skills by this author →
GitHub

polish

Restructure public repository files and generate README, CONTRIBUTING, and LICENSE documents.

3|Updated Mar 1, 2026
Search Tags:#file organization#security audit#readme generation#open-source#repository cleanup
One-click install
npx skills add https://github.com/onblueroses/strata --skill polish-onblueroses
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: polish
Source: https://github.com/onblueroses/strata/tree/main/skills/polish
Command: npx skills add https://github.com/onblueroses/strata --skill polish-onblueroses

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill restructures and enhances public repositories to ensure they are presentable and secure for release, making them more appealing to users and contributors.

Core Features & Use Cases

  • File Restructuring: Organize files according to ecosystem conventions to improve readability and maintainability.
  • README and Document Generation: Creates comprehensive README and CONTRIBUTING.md files.
  • Privacy Sweep: Removes sensitive data and flags potential risks from the repository history.
  • License Addition: Ensures repositories have a default LICENSE file.
  • Use Case: When preparing a GitHub repository for public release, use this Skill to structure the files, add necessary documentation, and clean up any private data.

Quick Start

Use the /polish command to initiate the repository polishing process.

Frequently Asked Questions about polish

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I prepare a GitHub repository for public release?▼

Preparing a repository for public release involves restructuring files, generating README and CONTRIBUTING.md files, executing a privacy sweep, and adding a default LICENSE file to ensure professional presentation and security.

How do I sanitize repository history for sensitive data before open-sourcing?▼

Sanitizing repository history for open-source release requires executing a privacy sweep to remove sensitive data and flag potential risks before public distribution.

What is the best way to generate README and CONTRIBUTING files for an open-source project?▼

The best way to generate README and CONTRIBUTING files is using automated documentation generation that creates comprehensive guides based on repository structure and content.

Can I automatically reorganize files in my public repository according to ecosystem conventions?▼

Yes, you can automatically reorganize files in your public repository according to ecosystem conventions to improve readability and maintainability before public distribution.

Does repository cleanup add a default LICENSE file if one is missing?▼

Yes, repository cleanup ensures that public repositories have a default LICENSE file added during the polishing process to meet professional open-source standards.

What are the limitations of automated repository polishing for code bases?▼

Automated repository polishing operates within predefined security boundaries, focusing on sanitizing and structuring content, but may not catch all complex or deeply embedded sensitive risks without manual review.

Related Skills

Explore More Software Engineering Skills→
dogekikidogekiki

overleaf-sync

Synchronize local LaTeX directories with Overleaf projects via Git.

Community
Advanced
abhishekdutta18abhishekdutta18

opensource-pipeline

Automates forking, sanitizing, and packaging private repositories for public open-source release.

Community
Advanced
marcospmailmarcospmail

run-e2e-tests

Automate end-to-end test suites for the Yato tmux orchestrator.

Community
Intermediate
bianhaifeng789-huebianhaifeng789-hue

sanitize-git-repo

Detect and remove committed secrets from git repositories and history.

Community
Advanced