Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
xkeshav committed Sep 30, 2024
1 parent 41b8592 commit 1d0e7fd
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 896 deletions.
37 changes: 22 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,30 @@

<!-- -->

```bash
npx gh-repo-check
```

![gh-repo-check demo gif](src/assets/images/output.gif)

## What it is ?
## What are Community Health Files?

> [!TIP]
> Read official Github docs to know more about [Community Health Files][community-files].
> [!Tip]
> Read [Official GitHub Docs][community-files] to know what are community health files
## What this package does ?

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 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 update necessary details in the community health files and apart from that this tool help to generate customized issues and discussions template
This tool generate below files with your personalized information

and below are the files in generated folder
- necessary community health files
- Issues templates
- Discussions templates
- Pull Request template
- Funding information

and below is the final folder structure

<details><summary>
<mark> Health File Tree</mark>
Expand Down Expand Up @@ -57,7 +69,7 @@ and below are the files in generated folder

## How to start

this is optional
install the repo in your node based project

```bash
npm install @xkeshav/gh-repo-check
Expand All @@ -69,15 +81,10 @@ and then run
npx gh-repo-check
```

it will ask few question and then generate files,

> [!Note]
> if you already have `.github` folder in your repo, then it will ask new folder name, where it will generate
> later you have to move these files into `.github` folder, to make it useful.
### Note
it will ask few questions and then generate files.

one file _Funding.yml_ file get generated, you can keep it empty for now.
> [!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

Expand Down
10 changes: 5 additions & 5 deletions bin/package.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#! /usr/bin/env node
import enquirePkg from "enquirer";
import semverPkg from "semver";
//import semverPkg from "semver";

const { valid } = semverPkg;
//const { valid } = semverPkg;
// @ts-ignore
const { Snippet } = enquirePkg;

Expand Down Expand Up @@ -36,9 +36,9 @@ const packagePrompt = new Snippet({
*/
// @ts-ignore
validate(value, state, item) {
if (item && item.name === "version" && !valid(value)) {
return packagePrompt.styles.danger("version should be a valid semver value");
}
//if (item && item.name === "version" && !valid(value)) {
// return packagePrompt.styles.danger("version should be a valid semver value");
//}
return true;
},
},
Expand Down
45 changes: 0 additions & 45 deletions docs/README.md

This file was deleted.

Loading

0 comments on commit 1d0e7fd

Please sign in to comment.