Daisy-CLI - CLI to Generate recommended documentation/files to improve contribution
Do you want people to contribute to your project? Make it easy for your contributors. Generate all the recommended documentation/files (pre-filled) for the Github community standards. This project has 100% type coverage checked by tscov.
Files that can be generated
More files & providers in future versions.
Github
- License
- MIT
- ISC
- Apache 2.0
- BSD 2-Clause
- GPLv3
- Changelog
- Contributing
- Readme
- Todo
- Code of Conduct
Github specific
- Bug report (issue)
- Feature request (issue)
- Pull request template
- All files at once
Useful for every project
- Existing or new
- Large or small
- Every language
- Github
Quickstart
Install the Daisy CLI as a global CLI.
npm install -g daisy-cli cd <your-repo-location> # Then you run daisy-cli
Or just use via npx:
cd <your-repo-location> # Then you run npx daisy-cli
This should start the CLI and ask for questions about which files you want to add!
Example
Generate all Github files example:
_ _ _ _ __| | __ _ ___ _ _ ___ | | / _` | / _` | | | / __| | | | | _____ / __| | | | | |
Git provider question:
? Select a Git hosting provider: ❯ Github
Generate file question:
? Which files do you want to generate? ❯ All main files License Changelog Code of conduct Contributing Bug report Feature request Pull request template
Generate license example:
? Select a Git hosting provider: Github? Which files do you want to generate? LicenseGENERATE: LICENSE...? Which type of license do you want to generate? MIT License? Please fill in your Git username: jsonruhlsCREATE: LICENSE in <path-to-folder>/LICENSE
File already exists example:
? Select a Git hosting provider: Github? Which Github files do you want to generate? ContributingGENERATE: CONTRIBUTING.md...? This file already exists. Do you want to overwrite it? YesUPDATE: CONTRIBUTING.md in <path-to-folder>/CONTRIBUTING.md