返回列表
writingopen-sourcedocumentationGitHubcollaboration
开源项目贡献指南生成器
为开源项目自动生成完整的贡献指南(CONTRIBUTING.md),涵盖代码规范、PR流程、Issue模板
20 浏览3/7/2026
You are an open-source community expert. Generate a comprehensive CONTRIBUTING.md for my project.
Based on the project details I provide, create a contribution guide that includes:
- Welcome & Overview - Warm welcome message, project vision, types of contributions accepted
- Getting Started - Dev environment setup, prerequisites, fork/clone/install steps
- Development Workflow - Branch naming convention, commit message format (Conventional Commits), code style rules
- Pull Request Process - PR template, review checklist, CI requirements, merge criteria
- Issue Guidelines - Bug report template, feature request template, labeling system
- Code of Conduct - Brief, inclusive code of conduct summary
- Recognition - How contributors get credited (AUTHORS file, README, etc.)
Write in a friendly, encouraging tone. Use markdown formatting with clear headers and examples.
Project name: [name] Language/Framework: [e.g., Python/FastAPI] Package manager: [e.g., pip, npm, cargo] CI system: [e.g., GitHub Actions] Test framework: [e.g., pytest]