Template repository

Tools

Shell

Format	shfmt
Lint	shellcheck

Code analyze

Code Complexity & Duplication Check

lizard

Configuration

JSON

Format	dprint with JSON plugin
Lint	Dasel

YAML

Format	dprint with Prettier plugin
Lint	yamllint

TOML

Format & Lint

taplo

INI

Format

editorconfig-checker

CI

Git hooks

Manage

pre-commit & pre-commit.ci

GitHub Actions

Lint	actionlint

Git

Commit message

Lint	Cocogitto (Conventional Commits)

Security

Detecting hardcoded secrets tool

Gitleaks

Writing docs

Natural language

Lint	Vale
Spell Check	Docs Vale Source Code typos

Caution

Asciidoctor is required to lint an AsciiDoc file.

Markdown

Format	dprint with Markdown plugin
Lint	markdownlint-cli

Release

Generate	git-cliff
Bump version	Cocogitto

Link

Checker

lychee

dependence

Automating dependency updater

Renovate

Tool Version Manager

Declaratively manage

aqua

Note	See docs/dev for more details.

Supported Platforms

• ✓ Linux

• ❏ macOS

• ❏ Windows

Introduction

Setup

1. Create repository with this template

   • gh repo create <REPOSITORY_NAME> --public --template hituzi-no-sippo/template-repository

   • Use this template

2. Clone repository
   gh repo clone <REPOSITORY_NAME> && cd <REPOSITORY_NAME>

3. Install aqua

4. Run setup shell
   bash scripts/setup.sh

5. Replace hituzi-no-sippo/template-repository

   • ./cliff.toml

6. Setup Renovate

7. Install GitHub Apps

   • pre-commit ci

   • Cocogitto-bot

TODO

• ❏ Migration git hook manager from pre-commit to Lefthook
  Need to create scripts to replace pre-commit-hooks.
  Comparison between lefthook and pre-commit.

• ❏ Add a tool to verify the licenses of dependencies
  Use Licensed.

• ❏ Add default community health files

  • ❏ Issue and pull request templates

  • ❏ CONTRIBUTING.md

  • ❏ CODE_OF_CONDUCT.md

  • ❏ SUPPORT.md

  • The following Community health files are designed to reference the default files (<GITHUB_USER_NAME>/.github)

    • FUNDING.yml

    • Discussion category forms

    • SECURITY.md

---

This project is available under the MIT-0 License.
Preservation of copyright and license notices isn’t required.

Copyright © 2022 hituzi no sippo