Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@xkeshav/gh-repo-check

Package Overview
Dependencies
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@xkeshav/gh-repo-check

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.

  • 1.2.1
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
1
Weekly downloads
 
Created
Source

GitHub Health File Check

License Open Issues Commit Count Pull Request npm version total download

 npx gh-repo-check

gh-repo-check 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 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
│   ├── 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.


Keywords

FAQs

Package last updated on 30 Sep 2024

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc