https://github.com/friedrith/contributing-generator
A generator for the CONTRIBUTING.md, README.md, LICENSE, etc
https://github.com/friedrith/contributing-generator
cli contributing markdown npm
Last synced: 8 months ago
JSON representation
A generator for the CONTRIBUTING.md, README.md, LICENSE, etc
- Host: GitHub
- URL: https://github.com/friedrith/contributing-generator
- Owner: friedrith
- License: mit
- Created: 2024-03-05T23:54:48.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-03-16T17:46:43.000Z (over 1 year ago)
- Last Synced: 2024-05-12T05:02:44.583Z (over 1 year ago)
- Topics: cli, contributing, markdown, npm
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/contributing-generator
- Size: 315 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
- awesome-cli-apps-in-a-csv - contributing-generator - A generator for the CONTRIBUTING.md, README.md, LICENSE, etc. (<a name="programming-boilerplate"></a>Program templates and boilerplate)
- awesome-cli-apps - contributing-generator - A generator for the CONTRIBUTING.md, README.md, LICENSE, etc. (<a name="programming-boilerplate"></a>Program templates and boilerplate)
README
# contributing-generator
A smart and interactive prompt to generate documentation in **CONTRIBUTING.md**, **LICENSE**, **CODE_OF_CONDUCT.md**, **package.json**, **SECURITY.md** 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.
## Get Started
```bash
$ npx contributing-generator
? What do you want to generate? (Use arrow keys)
❯ license
contributing
readme
code_of_conduct
pull_request_template
package
security
```
Check the templates of these files in the [templates](./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.
## Why using contributing-generator?
In comparison of other tools, it is smart and interactive. It will detect the license if existing, the year, the organization name from your github or gitlab and a lot of other information.
```bash
? What do you want to generate? license
? Choose a license: MIT # <-- coming from your package.json
? Year: 2024
? Organization: John Smith # <-- coming from your github profile
? Path: (/Users/john/code/contributing-generator)
```
> `contributing-generator` was tested with github, gitlab and bitbucket.
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code practices and the process for submitting pull requests.
```bash
pnpm install # Install dependencies
pnpm dev # Start the project
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.