oss-ready

Generate standard OSS repository files and GitHub templates.

104|15|Updated Feb 3, 2026
One-click install
npx skills add https://github.com/luongnv89/skills --skill oss-ready
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: oss-ready
Source: https://github.com/luongnv89/skills/tree/main/skills/oss-ready
Command: npx skills add https://github.com/luongnv89/skills --skill oss-ready

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes assets (resource) components.

What problem does it solve?

Transform projects into ready-to-publish OSS repositories by generating standard components and templates that ensure compliance and ease of collaboration.

Core Features & Use Cases

  • README.md: Project overview, quick start, installation guidance, and usage examples.
  • CONTRIBUTING.md and CODE_OF_CONDUCT.md: Governance for contributions and community interaction.
  • LICENSE and SECURITY.md: Licensing and vulnerability disclosure templates.
  • GitHub templates: ISSUE_TEMPLATE and PULL_REQUEST_TEMPLATE under assets/.github for issues and PRs.
  • Documentation structure: ARCHITECTURE.md, DEVELOPMENT.md, DEPLOYMENT.md, and CHANGELOG.md scaffolding.
  • Metadata & tooling: Update repository metadata and ensure .gitignore coverage and best practices.

Quick Start

Run oss-ready on your project to scaffold a complete OSS-ready repository with standard docs and templates.

Frequently Asked Questions about oss-ready

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

FAQPage Schema
How do I make my project an open-source repository?

Scaffold an open-source repository by generating standard governance files like README, CONTRIBUTING, LICENSE, and SECURITY policies. This creates a complete OSS package with coherent documentation structure and GitHub templates for immediate community collaboration.

What files are required for a public GitHub repository?

Required files for a public GitHub repository include README, LICENSE, CONTRIBUTING, and CODE_OF_CONDUCT. Additionally, generating SECURITY policies, ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE, and documentation like ARCHITECTURE.md ensures compliance and best practices for open-source collaboration.

How do I add issue and pull request templates to my repository?

Add issue and pull request templates by scaffolding them under the assets/.github directory. This creates standardized ISSUE_TEMPLATE and PULL_REQUEST_TEMPLATE files, ensuring contributors follow structured guidelines when submitting bug reports or code changes.

What documentation structure should I use for an open-source project?

An open-source project documentation structure should include ARCHITECTURE.md, DEVELOPMENT.md, DEPLOYMENT.md, and CHANGELOG.md scaffolding. This provides a coherent project structure that documents system design, local setup, deployment workflows, and version history for contributors.

Can I generate a complete OSS package without exposing sensitive data?

You can generate a complete OSS package without exposing sensitive data because the scaffolding process ensures assets exist and verifies that no sensitive data is introduced. It updates repository metadata and maintains .gitignore coverage to protect local configurations.

Does scaffolding open-source files update my project metadata and .gitignore?

Scaffolding open-source files updates repository metadata and ensures .gitignore coverage for best practices. It applies standardized templates across your project while verifying that no sensitive data is introduced into the public repository structure.