Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/haru52/base_template

Fully automated template repository which provides full compliance with the community standards.
https://github.com/haru52/base_template

base-template template

Last synced: about 1 month ago
JSON representation

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

Host: GitHub
URL: https://github.com/haru52/base_template
Owner: haru52
License: wtfpl
Created: 2022-04-26T12:57:49.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2024-09-23T12:23:04.000Z (4 months ago)
Last Synced: 2024-11-02T05:24:21.978Z (3 months ago)
Topics: base-template, template
Language: Makefile
Homepage: https://haru52.com/base_template/
Size: 2.38 MB
Stars: 2
Watchers: 2
Forks: 1
Open Issues: 5
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Security: docs/SECURITY.md

Awesome Lists containing this project

README

        
# Base Template Repository

[![Test](https://github.com/haru52/base_template/actions/workflows/test.yml/badge.svg)](https://github.com/haru52/base_template/actions/workflows/test.yml)

[![Release](https://github.com/haru52/base_template/actions/workflows/release.yml/badge.svg)](https://github.com/haru52/base_template/actions/workflows/release.yml)

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://haru52.github.io/base_template/CODE_OF_CONDUCT.html)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://commitizen.github.io/cz-cli/)

[![semantic-release: conventionalcommits](https://img.shields.io/badge/semantic--release-conventionalcommits-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

[![Contributors](images/contributors.png)](https://github.com/haru52/base_template/graphs/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](https://github.com/haru52/base_template/community) 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][base-template-cli].

## Uninstall

Nothing.

## Description

### Tech stack

| Category                      | Tool                                                                                  |

| ----------------------------- | ------------------------------------------------------------------------------------- |

| IDE/editor configuration      | [EditorConfig](https://editorconfig.org/)                                             |

| .gitignore management         | [gibo](https://github.com/simonwhitaker/gibo)                                         |

| Git hook                      | [Husky](https://typicode.github.io/husky)                                             |

| Git commit I/F                | [Commitizen](https://commitizen.github.io/cz-cli/)                                    |

| CI/CD                         | [GitHub Actions](https://github.com/features/actions)                                 |

| Code review                   | [reviewdog](https://github.com/reviewdog/reviewdog)                                   |

| Release                       | [semantic-release](https://semantic-release.gitbook.io/semantic-release/)             |

| Dependency update             | [Dependabot](https://docs.github.com/en/code-security/dependabot)                     |

| Lint: Git staged              | [lint-staged](https://github.com/okonet/lint-staged)                                  |

| Lint: Git commit message      | [commitlint](https://commitlint.js.org/)                                              |

| Lint: credentials             | [Secretlint](https://github.com/secretlint/secretlint)                                |

| Lint: Markdown                | [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli)                 |

| Lint: text (prose)            | [Vale](https://vale.sh/)                                                              |

| Lint: YAML                    | [yamllint](https://yamllint.readthedocs.io/)                                          |

| Lint: JSON, etc.              | [Prettier](https://prettier.io/)                                                      |

| Lint: GitHub Actions workflow | [actionlint](https://github.com/rhysd/actionlint)                                     |

| Lint: GitHub PR title         | [semantic-pull-request](https://github.com/marketplace/actions/semantic-pull-request) |

### Community Standards

[![Community Standards](images/community_standards.png)](https://github.com/haru52/base_template/community)

### Security overview

[![Security overview](images/security_overview.png)](https://github.com/haru52/base_template/security)

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](https://github.com/haru52/base_template/issues/new/choose).

#### CI fails

1. Go to `https://github.com///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][base-template-cli].

### Languages

- English (this repo. original)

- [日本語](https://github.com/haru52/base_template_ja)

## Versioning policy

[Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html)

## License

[WTFPL](LICENSE)

## Contributing

[Contributing Guideline](https://haru52.github.io/base_template/CONTRIBUTING.html)

## Documentation

[Documentation | base_template](https://haru52.github.io/base_template/)

## Author

[haru](https://haru52.com/)

[base-template-cli]: https://github.com/haru52/base_template_cli