contributor-guide-writer

Generate a CONTRIBUTING.md from detected project language, tooling, and workflow.

3|Updated Mar 31, 2026
One-click install
npx skills add https://github.com/sunny0826/open-source-skills --skill contributor-guide-writer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: contributor-guide-writer
Source: https://github.com/sunny0826/open-source-skills/tree/main/skills/contributor-guide-writer
Command: npx skills add https://github.com/sunny0826/open-source-skills --skill contributor-guide-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill analyzes the current workspace to generate a comprehensive, standardized CONTRIBUTING.md that fits the project's structure, tooling, and language preferences, saving maintainers time and ensuring consistent contributor guidelines.

Core Features & Use Cases

  • Analyze project structure to detect language ecosystems, package managers, and build tools.
  • Generate a local development setup, development workflow, testing and code-quality steps, and a clear PR process.
  • Support bilingual output (English/Chinese) and adapt to user language preferences.

Quick Start

Generate a CONTRIBUTING.md for the current project.

Frequently Asked Questions about contributor-guide-writer

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

FAQPage Schema
How do I auto-generate a CONTRIBUTING.md for an open-source project?

Auto-generate a CONTRIBUTING.md by analyzing the project's language, tooling, and contribution workflow to produce a tailored local development guide, workflow, and PR process.

What is the best way to create a contributing guide tailored to my repository's tooling?

Creating a tailored contributing guide involves detecting the repository's package managers and build tools to produce precise setup steps, applying verified commands from the workspace.

Does the contributing guide generator support bilingual output?

Yes, the contributing guide generator supports bilingual output, adapting the CONTRIBUTING.md content to user language preferences for English and Chinese.

How does the generated CONTRIBUTING.md handle commands that are not determinable?

When commands are not determinable from the repository, the generated CONTRIBUTING.md provides placeholders instead of guessing, ensuring the contributing guide only includes verified commands.

What should a standardized contributing guide include for local development setup?

A standardized contributing guide should include local development setup, development workflow, testing steps, code-quality checks, and a clear PR process tailored to the repository.

Why does my auto-generated contributing guide only show placeholder commands?

The auto-generated contributing guide shows placeholders when specific commands cannot be determinable from the repository, ensuring only verified commands are included in the CONTRIBUTING.md.