GitHub Repo Care
This is a npm CLI tool which help your GitHub repository to make it community supportive by adding necessary health files such as security/support/contribution/code of conduct/ funding and customized templates for pull requests/issues and discussions which boost your project for better contribution.
npx gh-repo-care
[!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
Health File Tree
├── .github
│ ├── CODEOWNERS
│ ├── CODE_OF_CONDUCT.md
│ ├── CONTRIBUTING.md
│ ├── DISCUSSION_TEMPLATE
│ │ ├── announcements.yml
│ │ └── ideas.yml
│ ├── FUNDING.yml
│ ├── GOVERNANCE.md
│ ├── ISSUE_TEMPLATE
│ │ ├── BUG_REPORT.yml
│ │ ├── ENHANCEMENT.yml
│ │ ├── FEATURE_REQUEST.md
│ │ ├── QUESTION.md
│ │ └── config.yml
│ ├── PULL_REQUEST_TEMPLATE.md
│ ├── SECURITY.md
│ ├── SUPPORT.md
Pre-requisite
How to start
install the repo in your node based project
npm install @xkeshav/gh-repo-care
and then run
npx gh-repo-care
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.