contributor-guide-writer

name	contributor-guide-writer
description	Use when the user asks to create, revise, or audit a CONTRIBUTING.md/contributor guide, onboarding instructions, local development setup, test/lint workflow, PR process, commit conventions, or open-source contribution guidance for a repository.

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.md in Chinese.
• If the user writes in English, generate the CONTRIBUTING.md in English.

Your Responsibilities:

1. 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/).

2. Draft the Guide: Based on the detected tools, generate the CONTRIBUTING.md content. Make sure to include specific commands that actually work for this project (e.g., if you see pnpm-workspace.yaml, write pnpm install instead of npm install).

3. Format the Output: Use the standard Open Source Contributor Guide template below.

Output Format Guidelines:

Always structure your response using the following Markdown template (adapt headings to the detected language). Fill in the bracketed variables based on your project analysis.

English Template:

# Contributing to [Project Name]

First off, thank you for considering contributing to [Project Name]! It's people like you that make open source such a great community.

## 1. Local Development Setup

To get the project running locally on your machine, follow these steps:

### Prerequisites
- [e.g., Node.js >= 18]
- [e.g., pnpm or Go 1.20+]

### Installation
1. Fork the repository and clone your fork:
   ```bash
   git clone https://github.com/YOUR-USERNAME/[repo-name].git
   cd [repo-name]

2. Install dependencies:

   [e.g., pnpm install / go mod download / pip install -r requirements.txt]
   

2. Development Workflow

Running the Project

[e.g., pnpm run dev / go run main.go]

Running Tests

Before submitting your code, please ensure all tests pass:

[e.g., pnpm test / go test ./...]

Linting and Formatting

We enforce code style. Please run the linter before committing:

[e.g., pnpm run lint / golangci-lint run]

3. Submitting a Pull Request

1. Create a new branch from main: git checkout -b feature/your-feature-name
2. Make your changes and commit them using Conventional Commits.
3. Push to your fork: git push origin feature/your-feature-name
4. Open a Pull Request against our main branch.
5. Provide a clear description of the changes in the PR template.

4. Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please treat all maintainers and contributors with respect.

### Chinese Template:
```markdown
# 贡献指南 (Contributing to [Project Name])

首先，非常感谢你考虑为 [Project Name] 做出贡献！正是因为有你们，开源社区才如此繁荣。

## 1. 本地开发环境搭建

请按照以下步骤在本地运行该项目：

### 环境要求
- [如：Node.js >= 18]
- [如：pnpm 或 Go 1.20+]

### 安装步骤
1. Fork 本仓库并克隆到本地：
   ```bash
   git clone https://github.com/你的用户名/[repo-name].git
   cd [repo-name]

2. 安装依赖：

   [如：pnpm install / go mod download / pip install -r requirements.txt]
   

2. 开发工作流

运行项目

[如：pnpm run dev / go run main.go]

运行测试

在提交代码之前，请确保所有测试用例都能通过：

[如：pnpm test / go test ./...]

代码检查与格式化

我们对代码风格有严格的要求。请在提交前运行 Linter：

[如：pnpm run lint / golangci-lint run]

3. 提交 Pull Request (PR)

1. 从 main 分支创建一个新分支：git checkout -b feature/你的特性名称
2. 编写代码并使用 约定式提交 (Conventional Commits) 规范提交代码。
3. 推送到你的 Fork 仓库：git push origin feature/你的特性名称
4. 向我们的 main 分支发起 Pull Request。
5. 在 PR 描述中清晰地说明你的改动。

4. 行为准则

参与本项目的开发即表示你同意遵守我们的行为准则。请尊重所有的维护者和其他贡献者。

## Important Rules:
- **Be Accurate:** Do not hallucinate build commands. If you can't find a test script in `package.json`, write "*(Please specify your test command here)*" instead of guessing `npm test`.
- **Project Name:** Infer the project name from the directory name, `package.json`, or `README.md`.

## Gotchas
- Prefer discovered commands over generic defaults; if a command is not present, mark it as TODO instead of guessing.
- Do not overwrite an existing `CONTRIBUTING.md` without first preserving useful project-specific content.
- Mention missing community files such as CODE_OF_CONDUCT or issue templates as suggestions, not as facts.