Agent skill · luongnv89
oss-ready
Transform a project into a professional open-source repository by adding LICENSE, README, CONTRIBUTING, CODE_OF_CONDUCT, SECURITY, and GitHub issue/PR templates. Don't use for documentation overhauls, landing-page generation, or registry publishing.
What it needs
About 5k tokens when loaded.
What this skill does
OSS Ready Transform a project into a professional open-source repository with standard community files and GitHub templates. Repo Sync Before Edits (mandatory) Before creating/updating/deleting files in an existing repository, sync the current branch with remote: If the working tree is not clean, stash first, sync, then restore: If origin is missing, pull is unavailable, or rebase/stash conflicts occur, stop and ask the user before continuing. Workflow Before proceeding, check Edge Cases below for a non-MIT LICENSE, a monorepo, no detectable language, a private/internal repo, or a dirty/detached HEAD — handle the matching case first if it applies. 0. Create Feature Branch Before making any changes: 1. Check the current branch - if already on a feature branch for this task, skip 2. Check the repo for branch naming conventions (e.g., feat/, feature/, etc.) 3. Create and switch to a new branch following the repo's convention, or fallback to: feat/oss-ready 1. Analyze Project Identify: Primary language(s) and tech stack Project purpose and functionality Existing documentation to preserve Package manager (npm, pip, cargo, etc.) 2. Create/Update Core Files README.md - Enhance with: Project overview and motivation Key features list Quick start (< 5 min setup) Prerequisites and installation Usage examples with code Project structure Technology stack Contributing link License badge CONTRIBUTING.md - Include: How to contribute overview Development setup Branching strategy (feature branches from main) Commit conventions (Conventional Commits) PR process and review expectations Coding standards Testing requirements LICENSE - Default to MIT unless specified. Copy from assets/LICENSE-MIT. CODEOFCONDUCT.md - Use Contributor Covenant. Copy from assets/CODEOFCONDUCT.md. SECURITY.md - Vulnerability reporting process. Copy from assets/SECURITY.md. 3. Create GitHub Templates Copy from assets/.github/: ISSUETEMPLATE/bugreport.md ISSUETEMPLATE/featurerequest.md PULLREQUESTTEMPLATE.md 4. …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills luongnv89/oss-ready