skip to content
Keshav Mohta

GitHub Health Files

/ 1 min read

blog , github , open-source , community , health-files , package.json

Health Files

4 main files must be in every Github Repo

  • README.md
  • LICENSE
  • CODE_OF_CONDUCT.md
  • CONTRIBUTION_GUIDE.md

Additional files which help to build a inclusive open source project and invite for collaboration

here are full list of all health files

Terminal window
.
├── CHANGELOG.md
├── docs
│   └── README.md
├── .editorconfig
├── .github
│   ├── CODE_OF_CONDUCT.md
│   ├── CODEOWNERS
│   ├── CONTRIBUTING.md
│   ├── DISCUSSION_TEMPLATE
│   │   ├── announcements.yml
│   │   └── ideas.yml
│   ├── FUNDING.yml
│   ├── ISSUE_TEMPLATE
│   │   ├── BUG_FORM.yml
│   │   ├── config.yml
│   │   ├── ENHANCEMENT.yml
│   │   ├── FEATURE_REQUEST.md
│   │   └── QUESTION.md
│   ├── PULL_REQUEST_TEMPLATE.md
│   ├── SECURITY.md
│   ├── SUPPORT.md
│   └── workflows
│       └── markdown-lint.yml
├── .gitignore
├── LICENSE
├── package.json
├── public
│   └── assets
│       └── images
├── README.md
├── src
│   └── index.js
├── template.code-workspace
├── .tree
└── .vscode
    ├── cspell.json
    ├── dictionaries
    │   ├── project-words.txt
    │   └── team-member.txt
    ├── extensions.json
    ├── javascriptreact.json
    ├── markdownlint.json
    ├── pkg.json
    ├── settings.json
    ├── tasks.json
    └── template.code-snippets

you can check more at this template repository

Thanks