Contributing Guide Generator
Generate a CONTRIBUTING.md template for your open-source project.
$CONTRIBUTING.md[READY]
0 chars1 lines
Related Tools
FAQ
- Why should my project have a CONTRIBUTING.md?
- A CONTRIBUTING.md file sets clear expectations for contributors, reducing back-and-forth on pull requests. It explains how to set up the development environment, coding standards, how to submit issues, and what the PR review process looks like.
- Where should I place CONTRIBUTING.md?
- Place it in the root of your repository. GitHub, GitLab, and Bitbucket automatically link to CONTRIBUTING.md from the new issue and pull request pages, making it highly visible to contributors.
- Should I include a Code of Conduct?
- Yes, for any public project. A Code of Conduct sets expectations for community behaviour. The most commonly used one is the Contributor Covenant (contributor-covenant.org). You can reference it from your CONTRIBUTING.md or include a separate CODE_OF_CONDUCT.md file.
Create a professional CONTRIBUTING.md file by filling in your project name, primary language, code style guide, and PR process. The generated guide covers: how to report bugs, how to suggest features, development setup, coding conventions, the pull request workflow, and code of conduct references. Helps onboard new contributors quickly.