Back to list
writingopen-sourcedocumentationGitHubcollaboration
Open Source Project Contribution Guidelines Generator
Automatically generate a complete contribution guide (CONTRIBUTING.md) for open source projects, covering code specifications, PR process, and Issue templates
21 views3/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]