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 and Gitlab community standards. Files for CodeCommit (AWS) or Bitbucket can be generated too. This project has 99+% type coverage checked by tscov.
Generate multiple files at once
Generate a license
More files & providers in future versions.
Install the CGX CLI as a global CLI.
npm install -g cgx cd <your-repo-location> # Then you run cgx
Or just use via npx:
cd <your-repo-location> # Then you run npx cgx
This should start the CLI and ask for questions about which files you want to add!
Generate all Github files example:
____ ____ __ __ / ___| / ___| \ \/ / | | | | _ \ / | |___ | |_| | / \ \____| \____| /_/\_\ Generate all the recommended markdown documentation/templates for the Github and Gitlab community standards. Files for CodeCommit (AWS) or Bitbucket can be generated too ? Select a Git hosting provider: Github ? Which Github files do you want to generate? All recommended files (other files can be generated separate) INFO: Start generating all recommended files... GENERATE: CODE_OF_CONDUCT.md... GENERATE: CONTRIBUTING.md... GENERATE: bug_report.md... GENERATE: feature_request.md... GENERATE: pull_request_template.md... CREATE: bug_report.md in .github/ISSUE_TEMPLATE/bug_report.md CREATE: CODE_OF_CONDUCT.md.md CREATE: CONTRIBUTING.md CREATE: feature_request.md in .github/ISSUE_TEMPLATE/feature_request.md CREATE: pull_request_template.md in .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Git provider question:
? Select a Git hosting provider: (Use arrow keys) ❯ Github Gitlab CodeCommit (AWS) Bitbucket
Generate file question:
? Which Gitlab files do you want to generate? (Use arrow keys) ❯ All recommended files (other files can be generated separate) License Changelog Code of conduct Contributing Bug report (issue) Feature request (issue) Pull request template Readme Todo Dockerfile
Generate license example:
? Select a Git hosting provider: Github ? Which Gtihub files do you want to generate? License GENERATE: LICENSE... ? Which type of license do you want to generate? MIT License ? Please fill in your Git username: Jeroenouw CREATE: LICENSE
File already exists example:
? Select a Git hosting provider: Bitbucket ? Which Bitbucket files do you want to generate? Contributing GENERATE: CONTRIBUTING.md... ? This file already exists. Do you want to overwrite it? Yes UPDATE: CONTRIBUTING.md