@xkeshav/gh-repo-check
Advanced tools
This is a cli tool which help your GitHub repository to make it community supportive by adding necessary health files and customized templates for issues and discussions tab which boost your project for better contribution.
[!Tip] Read Official GitHub Docs to know what are community health files
This is a npm based CLI tool which help to check your GitHub repo and generate community health files in .github folder (if not exist) or user defined folder name.
This tool update necessary details in the community health files and apart from that this tool help to generate customized issues and discussions template
and below are the files in generated folder
├── .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
this is optional
npm install @xkeshav/gh-repo-check
and then run
npx gh-repo-check
it will ask few question and then generate files,
[!Note] if you already have
.githubfolder in your repo, then it will ask new folder name, where it will generate later you have to move these files into.githubfolder, to make it useful.
one file Funding.yml file get generated, you can keep it empty for now.
This project is licensed under the MIT License.
FAQs
This is a cli tool which help your GitHub repository to make it community supportive by adding necessary health files and customized templates for issues and discussions tab which boost your project for better contribution.
We found that @xkeshav/gh-repo-check demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.