Set Up an Open Source Project
A well-prepared open source project has more than just code — it needs a clear README, an appropriate license, a CHANGELOG, contributing guidelines, and a properly configured .gitignore. Creating these files from scratch for every new project takes time and requires knowing the conventions for each. devtoolkit.sh provides generators for every essential open source project file. Write a professional README, choose and generate the right license, create contributing guidelines that set clear expectations for contributors, generate a structured CHANGELOG, and produce a comprehensive .gitignore for your tech stack. All generators are free, run in your browser, and produce Markdown output ready to commit.
Generate a well-structured README.md from a simple form.
Browse open-source licenses and generate the full license text for your project.
Generate a CONTRIBUTING.md template for your open-source project.
Generate a CHANGELOG.md following the Keep a Changelog format.
Generate .gitignore files for any language or framework with a single click.
FAQ
- Which license should I choose for my open source project?
- MIT and Apache 2.0 are the most permissive and widely compatible choices. Use GPL or LGPL if you want copyleft protection. Creative Commons licenses are more appropriate for documentation and content than code.
- What should a CONTRIBUTING.md file include?
- How to report issues, how to submit pull requests, code style requirements, the development setup process, and the code of conduct. Clear contributing guidelines reduce back-and-forth with contributors.
- Do I need a CHANGELOG?
- A CHANGELOG is strongly recommended for any project with users. It records what changed in each release, helping users decide when to upgrade and understand breaking changes.