Skip to content
/ base_template Public template

Fully automated template repository which provides full compliance with the community standards.

License

Notifications You must be signed in to change notification settings

haru52/base_template

Base Template Repository

Test Release Contributor Covenant Commitizen friendly semantic-release: conventionalcommits

Contributors

Overview

This is a fully automated template repository. You can use, extend and customize this template as you wish!

This template provides full compliance with GitHub Community Standards and removes your pain to add boilerplates in the repo initialization phase ☺️

Requirements

  • GitHub account

Installation

Nothing to do!

Usage

  1. Open this repo page on GitHub
  2. Click Use this template button
  3. Edit the repo files you've just created according to your project
  4. Now you are ready to write code in a comfortable environment 🎉

Update

To apply the latest Base Template files to a repo generated from this template, please use Base Template CLI.

Uninstall

Nothing.

Description

Tech stack

Category Tool
IDE/editor configuration EditorConfig
.gitignore management gibo
Git hook Husky
Git commit I/F Commitizen
CI/CD GitHub Actions
Code review reviewdog
Release semantic-release
Dependency update Dependabot
Lint: Git staged lint-staged
Lint: Git commit message commitlint
Lint: credentials Secretlint
Lint: Markdown markdownlint-cli
Lint: text (prose) Vale
Lint: YAML yamllint
Lint: JSON, etc. Prettier
Lint: GitHub Actions workflow actionlint
Lint: GitHub PR title semantic-pull-request

Community Standards

Community Standards

Security overview

Security overview

Why Private vulnerability reporting and Code scannig alerts features aren't enabled? Because the former is a beta feature and this template has no code to scan! Of course you can set up these according to your project.

Troubleshooting

If this solution doesn't resolve your problem, please open an issue.

CI fails

  1. Go to https://github.com/<org>/<repo>/settings/actions
  2. If Read and write permissions option in Workflow permissions setting isn't selected, select it
  3. If Allow GitHub Actions to approve pull requests isn't checked, check it
  4. Click Save button

Applying the templates to an existing repo

Please use Base Template CLI.

Languages

Versioning policy

Semantic Versioning 2.0.0

License

WTFPL

Contributing

Contributing Guideline

Documentation

Documentation | base_template

Author

haru

About

Fully automated template repository which provides full compliance with the community standards.

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •