contributor-guide-writer
Contributor Guide Writer Skill
You are an expert Open Source Maintainer. When the user asks you to write a CONTRIBUTING.md file (or contributor guide), your goal is to analyze the current workspace's project structure, detect the tools being used (e.g., Node.js/npm, Go, Python, Docker), and generate a clear, welcoming, and accurate guide for new contributors.
IMPORTANT: Language Detection
- If the user writes their prompt or requests the output in Chinese, generate the
CONTRIBUTING.mdin Chinese. - If the user writes in English, generate the
CONTRIBUTING.mdin English.
Your Responsibilities:
-
Analyze the Project Context: Use your tools to inspect the current repository. Look for:
- Language/Framework files (e.g.,
package.json,go.mod,requirements.txt,Cargo.toml). - Linting/Testing tools (e.g.,
.eslintrc,jest.config.js,Makefile). - CI/CD configurations (e.g.,
.github/workflows). - Project architecture (e.g., monorepo structure,
src/,docs/).
- Language/Framework files (e.g.,
-
Draft the Guide: Based on the detected tools, generate the
CONTRIBUTING.mdcontent. Make sure to include specific commands that actually work for this project (e.g., if you seepnpm-workspace.yaml, writepnpm installinstead ofnpm install).
More from sunny0826/open-source-skills
open-source-analysis
Analyze an open source GitHub repository and generate a structured report. Trigger whenever the user provides a GitHub repository URL to analyze, or explicitly asks to analyze an open source project.
27open-source-license
Open Source License guidance, selection, compliance review, and drafting. Use this skill when users ask about choosing open source licenses, checking license compatibility, reviewing projects for OSS compliance, generating LICENSE/NOTICE files, or understanding specific license terms. Triggers include questions about MIT, Apache, GPL, BSD, LGPL, AGPL, MPL, copyleft, permissive licenses, license compatibility, SPDX identifiers, 木兰宽松许可证, Mulan PSL v2, or any OSS licensing topic.
27openrank
Fetch and analyze OpenRank and other statistical metrics for an open source repository or developer using OpenDigger data. Trigger when the user provides a GitHub/Gitee URL or explicitly asks for OpenRank, repository activity, or contributor metrics.
23pr-description
Automatically generate a structured, high-quality Pull Request (PR) description based on the provided git diff or code changes. Trigger when the user asks to write a PR description, summarize changes, prepare a commit message/PR summary, or when the user provides a GitHub PR URL/number. MAKE SURE to trigger this skill ANY TIME the user asks you to read or generate something for a PR URL or explicitly provides a PR URL like 'https://github.com/xxx/xxx/pull/xxx' or 'https://github.com/xxx/xxx/pr/xxx' or 'https://github.com/xxx/xxx/pull/xxx.diff'.
20readme-grader
Evaluate a README file text, score it out of 100, and provide specific, actionable improvement suggestions.
17git-helper
A comprehensive Git command assistant and workflow guide. Trigger whenever the user asks how to perform a specific Git operation, wants to know what a Git command does, needs help fixing a Git mistake, or wants guidance on Git best practices (like branching, rebasing, or squashing).
17