Loading...
Loading...
Analyze the current project structure, package manager, and build tools to generate a comprehensive, standardized CONTRIBUTING.md file. Trigger when the user asks to write or generate a contributing guide, or wants to know how to set up the project locally for development.
npx skill4agent add sunny0826/open-source-skills contributor-guide-writerCONTRIBUTING.mdCONTRIBUTING.mdCONTRIBUTING.mdpackage.jsongo.modrequirements.txtCargo.toml.eslintrcjest.config.jsMakefile.github/workflowssrc/docs/CONTRIBUTING.mdpnpm-workspace.yamlpnpm installnpm install# 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][e.g., pnpm install / go mod download / pip install -r requirements.txt][e.g., pnpm run dev / go run main.go][e.g., pnpm test / go test ./...][e.g., pnpm run lint / golangci-lint run]maingit checkout -b feature/your-feature-namegit push origin feature/your-feature-namemain
### 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][如:pnpm install / go mod download / pip install -r requirements.txt][如:pnpm run dev / go run main.go][如:pnpm test / go test ./...][如:pnpm run lint / golangci-lint run]maingit checkout -b feature/你的特性名称git push origin feature/你的特性名称main
## 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`.