npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@xkeshav/gh-repo-check

v1.2.1

Published

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.

Downloads

228

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

xkeshavxkeshav

Keywords

health-checkrepo-health-checkcommunity fileshealth filescommunity health filesopen sourcegh-repo-checkcliGitHubissues templatesdiscussion templates

Readme

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

├── .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.