Awesome Open Source
Awesome Open Source

CGX - CLI to Generate recommended documentation/files to improve contribution

npmversion npmlicense downloads

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

Files that can be generated

More files & providers in future versions.

Github, Gitlab, CodeCommit and Bitbucket

  • License
    • MIT
    • ISC
    • Apache 2.0
    • BSD 2-Clause
    • GPLv3
    • CCOv1
  • Changelog
  • Contributing
  • Readme
  • Todo
  • Code of Conduct
  • Dockerfile

Github specific

  • Bug report (issue)
  • Security vulnerability report
  • Feature request (issue)
  • Pull request template
  • All files at once

Gitlab specific

  • CI template
  • Bug (issue)
  • Feature proposal (issue)
  • Merge request
  • All files at once

CodeCommit specific

  • Buildspec (AWS CodeBuild)
  • Appspec (AWS CodeDeploy)
  • All files at once

Bitbucket specific

  • In future versions

Useful for every project

  • Existing or new
  • Large or small
  • Every language
  • Github, Gitlab, CodeCommit (AWS) or Bitbucket

Quickstart

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!

Example

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

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
typescript (12,087
cli (1,847
aws (1,132
markdown (888
github (777
documentation (609
template (549
generator (353
community (187
gitlab (164
templates (118
bitbucket (66
documentation-generator (52