Skip to content

Latest commit

 

History

History
129 lines (92 loc) · 4.23 KB

README.md

File metadata and controls

129 lines (92 loc) · 4.23 KB
Raw

GitHub Repo Care

A npm based CLI tool which help your GitHub repository to make it community supportive by generating necessary health files such as security/support/contribution/funding and customized template for pull requests/issues and discussions which boost your project for better contribution.

License Open Issues Commit Count Pull Request npm version total download

Publish package to GitHub Packages
Publish Package to NPM

 npx gh-repo-care

gh-repo-care demo gif

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 which check your GitHub repo and generate community health files which should be placed in your .github folder.

This tool generate total 15 files with your personalized information

  • Github Community Health files (5)
  • Issues template files (5)
  • Discussions template files (2)
  • Pull Request template file (1)
  • Funding (1)
  • CODEOWENERS file (1)

below is the final folder structure

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

4 directories, 15 files

Pre-requisite

  • Node 20+

How to start

Install the repo in your node based project

npm install @xkeshav/gh-repo-care

and then run

npx gh-repo-care

type y to continue on asking

then it will ask few questions and ask for your consent and then generate necessary health files.

Notes

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.

  • Enable Discussions tab from Github repository settings to use discussions template
  • You must have Github Sponsor profile to enable funding for your GitHub Repository;

Caution

if you already have .github folder and choose No for that question then it will overwrite the files under .github folder

License

This project is licensed under the MIT License.