contributing-generator
Advanced tools
A smart and interactive prompt to generate documentation in CONTRIBUTING.md, LICENSE, CODE_OF_CONDUCT.md, package.json and README.md files for your project.
contributing-generator gathers as maximum information as possible from your git configuration, package.json and github profile to generate the files.
$ npx contributing-generator
? What do you want to generate? (Use arrow keys)
❯ license
contributing
readme
code_of_conduct
pull_request_template
package
Check the templates of these files in the templates folder.
We suggest you to commit your changes before running the generator, as it will overwrite some files and you might want to revert some changes.
contributing-generator is a tool to help you generate a lot of useful markdown files for your project. And it is smart to avoid you to type the same information multiple times.
For example, it will detect the license if existing, the year, the organization name from your github:
? What do you want to generate? license
? Choose a license: MIT
? Year: 2024
? Organization: John Smith
? Path: (/Users/john/code/contributing-generator)
Contributing works perfectly for github but it still needs to be tested for other git providers.
Please read CONTRIBUTING.md for details on our code practices and the process for submitting pull requests.
pnpm install # Install dependencies
pnpm dev # Start the project
This project is licensed under the MIT License - see the LICENSE file for details.
FAQs
A generator for the CONTRIBUTING.md files and cie
The npm package contributing-generator receives a total of 0 weekly downloads. As such, contributing-generator popularity was classified as not popular.
We found that contributing-generator demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Create React App is officially deprecated due to React 19 issues and lack of maintenance—developers should switch to Vite or other modern alternatives.
Security News
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.
Security News
The Linux Foundation is warning open source developers that compliance with global sanctions is mandatory, highlighting legal risks and restrictions on contributions.