template

Template Repository

This is a template repository which contains

• community health files under mostly under .github
• package.json boilerplate
• github action under .github/workflows for markdown file validity
• .vscode folder which have
  • code snippets
  • user / workspace settings file
  • recommended extensions
  • project dictionaries

Pre-requisite

• Node 18+
• VS Code IDE

How to use this Template repository

• Open this repository in GitHub
• Click on use this template tab; near star tab
• Make necessary changes in
  • package.json
    • replace template with your project name.
  • markdown files under .github folder
    • change contact email address and url wherever required.

Folder Tree

Repository Folder Structure

```bash ├── .editorconfig ├── .github │   ├── CODEOWNERS │   ├── CODE_OF_CONDUCT.md │   ├── CONTRIBUTING.md │   ├── DISCUSSION_TEMPLATE │   │   ├── announcements.yml │   │   └── ideas.yml │   ├── FUNDING.yml │   ├── ISSUE_TEMPLATE │   │   ├── BUG_FORM.yml │   │   ├── ENHANCEMENT.yml │   │   ├── FEATURE_REQUEST.md │   │   ├── QUESTION.md │   │   └── config.yml │   ├── PULL_REQUEST_TEMPLATE.md │   ├── SECURITY.md │   ├── SUPPORT.md │   └── workflows │   └── markdown-lint.yml ├── .gitignore ├── .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 ├── CHANGELOG.md ├── LICENSE ├── README.md ├── docs │   └── README.md ├── package.json ├── public │   └── assets │   └── images ├── src │   └── index.js ├── template.code-workspace └── tree 12 directories, 36 files ```

---

License

This project is licensed under the MIT License.

---

[!Caution] Please update the readme and package.json as per your project. Make sure to remove or update the CODEOWNERS file.

This site is open source. Improve this page.