Base Template Repository

A base template repository that all other template repos can inherit from to ensure tooling consistency

Table of Contents

• Base Template Repository
  • Table of Contents
  • About
  • Supported Tooling
    • Visual Studio Code
      • Development Containers
    • GitHub
      • GitHub Pages
      • Discussion Templates
      • Actions
      • Issue Templates
    • Pre-Commit
      • Hooks
    • Docker
    • Make
    • RAD
    • EditorConfig
  • Template Structure

About

This is a template repository that is intended to be inherited by other template repositories to ensure consistent common tool deployment across languages.

This will also support optional tooling that services like GitHub offer in order to provide repository owners access to these features without them having to discover it themselves.

Additionally, while projects can leverage this template or its content, this template is primarily intended to build other templates off of it.

Supported Tooling

Visual Studio Code

• Website: https://code.visualstudio.com/
• File(s):
  • Development Containers: .devcontainer/

Development Containers

• File: .devcontainer/devcontainer.json
• Documentation: https://containers.dev/implementors/json_reference
• Base image: alpine:latest
• Extensions:
  • CodeSnap
  • File Tree Generator
  • Markdown All In One
  • markdownlint
    • Config file: .markdownlint.json
  • vscode-icons
  • Docker
  • Makefile Tools
  • EditorConfig
    • Config file: .editorconfig

GitHub

• Website: https://github.com
• File(s): .github/
• Documentation: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file
• Features
  • Code Of Conduct: .github/CODE_OF_CONDUCT.md
  • Code Owners: .github/CODEOWNERS
  • Citations: CITATION.cff
  • Contributing Guide: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • Governance: .github/GOVERNANCE.md
  • Security: .github/SECURITY.md
  • Support: .github/SUPPORT.md

GitHub Pages

• File: _config.yml
• Documentation: https://docs.github.com/en/pages

Discussion Templates

• File(s): .github/DISCUSSION_TEMPLATE/
• Documentation: https://docs.github.com/en/discussions/managing-discussions-for-your-community/creating-discussion-category-forms
• Templates:
  • Implentation: .github/DISCUSSION_TEMPLATE/implementations.yml
  • Requests: .github/DISCUSSION_TEMPLATE/requests.yml

Actions

• File(s): .github/workflows/
• Documentation: https://docs.github.com/en/actions
• Actions:
  • Pre-Commit: .github/workflows/pre-commit.yml
    • Documentation: https://github.com/pre-commit/action
  • GitHub Pages Publishing: .github/workflows/jekyll-gh-pages.yml

Issue Templates

• File(s): .github/ISSUE_TEMPLATE/
• Templates:
  • Bug Reports: .github/ISSUE_TEMPLATE/bug-report.yml

Pre-Commit

• Website: https://pre-commit.com/
• File: .pre-commit.yaml

Hooks

• mdformat
  • Config: .mdformat.toml

Docker

• Website: https://www.docker.com/
• File: Dockerfile
• Base image: alpine:latest

Make

• Website: https://makefiletutorial.com/
• File: Makefile
• Targets:
  • build
  • create-dev

RAD

• Website: https://github.com/NicholasSynovic/tool_rad
• File: .rad.json

EditorConfig

• Website: https://editorconfig.org/
• File: .editorconfig

Template Structure

Generated with File Tree Generator

📦template_base
 ┣ 📂.devcontainer
 ┃ ┗ 📜devcontainer.json
 ┣ 📂.github
 ┃ ┣ 📂DISCUSSION_TEMPLATE
 ┃ ┃ ┣ 📜implementations.yml
 ┃ ┃ ┗ 📜requests.yml
 ┃ ┣ 📂ISSUE_TEMPLATE
 ┃ ┃ ┗ 📜bug-report.yml
 ┃ ┣ 📂workflows
 ┃ ┃ ┣ 📜jekyll-gh-pages.yml
 ┃ ┃ ┗ 📜pre-commit.yml
 ┃ ┣ 📜CODEOWNERS
 ┃ ┣ 📜CODE_OF_CONDUCT.md
 ┃ ┣ 📜CONTRIBUTING.md
 ┃ ┣ 📜FUNDING.yml
 ┃ ┣ 📜GOVERNANCE.md
 ┃ ┣ 📜SECURITY.md
 ┃ ┗ 📜SUPPORT.md
 ┣ 📂docs
 ┃ ┗ 📜.gitkeep
 ┣ 📜.editorconfig
 ┣ 📜.markdownlint.json
 ┣ 📜.mdformat.toml
 ┣ 📜.pre-commit-config.yaml
 ┣ 📜.rad.json
 ┣ 📜CITATION.cff
 ┣ 📜Dockerfile
 ┣ 📜LICENSE
 ┣ 📜Makefile
 ┗ 📜README.md