@xkeshav/gh-repo-check v1.2.1

GitHub Health File Check

 npx gh-repo-check

What are Community Health Files?

!TIP Read official Github docs to know more about Community Health Files.

What this package does ?

This is a npm based CLI tool check your GitHub repo and generate basic community health files in .github folder (if not exist) or user defined folder.

This tool generate below files with your personalized information

• necessary community health files
• Issues templates
• Discussions templates
• Pull Request template
• Funding information

and below is the final folder structure

├── .github
│   ├── CODEOWNERS
│   ├── CODE_OF_CONDUCT.md
│   ├── CONTRIBUTING.md
│   ├── DISCUSSION_TEMPLATE
│   │   ├── announcements.yml
│   │   └── ideas.yml
│   ├── FUNDING.yml
│   ├── ISSUE_TEMPLATE
│   │   ├── BUG_REPORT.yml
│   │   ├── ENHANCEMENT.yml
│   │   ├── FEATURE_REQUEST.md
│   │   ├── QUESTION.md
│   │   └── config.yml
│   ├── PULL_REQUEST_TEMPLATE.md
│   ├── SECURITY.md
│   ├── SUPPORT.md

Pre-requisite

• Node 20+

How to start

install the repo in your node based project

npm install @xkeshav/gh-repo-check

and then run

npx gh-repo-check

it will ask few questions and then generate files.

!NOTE if you have .github folder in your repo, then it will ask for a folder name, where it will generate the files, but later you have to move these files into .github folder, to make it useful.

License

This project is licensed under the MIT License.