Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xkeshav/gh-repo-care
A CLI tool which generate community health files for a GitHub repository
https://github.com/xkeshav/gh-repo-care
community-project github health-files npm-cli npm-package
Last synced: 7 days ago
JSON representation
A CLI tool which generate community health files for a GitHub repository
- Host: GitHub
- URL: https://github.com/xkeshav/gh-repo-care
- Owner: xkeshav
- License: mit
- Created: 2024-09-29T09:10:48.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-10-15T17:25:19.000Z (22 days ago)
- Last Synced: 2024-10-17T00:24:22.879Z (21 days ago)
- Topics: community-project, github, health-files, npm-cli, npm-package
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@xkeshav/gh-repo-care
- Size: 1.36 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
- Support: .github/SUPPORT.md
- Governance: .github/GOVERNANCE.md
Awesome Lists containing this project
README
# 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][license]][license-link]
[![Open Issues][issues]][issue-link]
[![Commit Count][commits]][commit-link]
[![Pull Request][PR]][pr-link]
[![npm version][npm version]][npm-package]
[![total download][download]][npm-package]
[](https://github.com/xkeshav/gh-repo-care/actions/workflows/publish.yml)
[](https://github.com/xkeshav/gh-repo-care/actions/workflows/npm-publish.yml)
```bash
npx gh-repo-care
```
## What are Community Health Files?
> [!TIP]
> Read official Github docs to know more about [Community Health Files][community-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
```lang-none
./.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
```sh
npm install @xkeshav/gh-repo-care
```
and then run
```bash
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][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][license-link].
---
[license]: https://badgen.net/github/license/xkeshav/gh-repo-care
[issues]: https://badgen.net/github/open-issues/xkeshav/gh-repo-care
[PR]: https://badgen.net/github/prs/xkeshav/gh-repo-care
[commits]: https://badgen.net/github/commits/xkeshav/gh-repo-care/main?color=green
[npm version]: https://badgen.net/npm/v/@xkeshav/gh-repo-care
[download]: https://badgen.net/npm/dy/@xkeshav/gh-repo-care
[license-link]: https://github.com/xkeshav/gh-repo-care/tree/main?tab=MIT-1-ov-file#readme
[npm-package]: https://www.npmjs.com/package/@xkeshav/gh-repo-care
[commit-link]: https://github.com/xkeshav/gh-repo-care/commits/main/
[issue-link]: https://github.com/xkeshav/gh-repo-care/issues
[pr-link]: https://github.com/xkeshav/gh-repo-care/pulls
[community-files]: https://docs.github.com/en/[email protected]/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file
[github-sponsor]: https://docs.github.com/en/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor-through-github