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_ja

完全に自動化されたテンプレートリポジトリです。コミュニティスタンダードに完全準拠しています。
https://github.com/haru52/base_template_ja

base-template template

Last synced: 6 days ago
JSON representation

完全に自動化されたテンプレートリポジトリです。コミュニティスタンダードに完全準拠しています。

Host: GitHub
URL: https://github.com/haru52/base_template_ja
Owner: haru52
License: wtfpl
Created: 2022-05-04T09:01:21.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2024-09-23T17:17:00.000Z (5 months ago)
Last Synced: 2024-12-20T14:22:12.875Z (2 months ago)
Topics: base-template, template
Language: Makefile
Homepage: https://haru52.com/base_template_ja/
Size: 3.31 MB
Stars: 1
Watchers: 2
Forks: 0
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

        # ベーステンプレートリポジトリ

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

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

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://haru52.github.io/base_template_ja/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_ja/graphs/contributors)

## 概要

完全に自動化されたテンプレートリポジトリです。あなたはお望みのままにこのテンプレートを利用、拡張、カスタマイズすることができます！

また、このテンプレートは [GitHub コミュニティスタンダード](https://github.com/haru52/base_template_ja/community)に完全準拠しています。このテンプレートはリポジトリ初期化フェーズにおける定型的なファイルの追加という苦痛を取り除きます ☺️

## 動作要件

- GitHub アカウント

## インストール

特になし！

## 利用方法

1. GitHub で当リポジトリのページを開く

2. `Use this template` ボタンをクリック

3. 作成したリポジトリのファイルをプロジェクトに応じて編集

4. お疲れ様でした！これにて快適な環境でコーディングする準備が整いました 🎉

## アップデート

当テンプレートを元に作成したリポジトリへ最新のベーステンプレートのファイルを適用するには、[Base Template CLI][base-template-cli] をご利用ください。

## アンインストール

特になし。

## 詳細

### 技術スタック

|            カテゴリー             |                                        ツール                                         |

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

| IDE／エディタ設定                 | [EditorConfig](https://editorconfig.org/)                                             |

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

| Git フック                        | [Husky](https://typicode.github.io/husky)                                             |

| Git コミット I/F                  | [Commitizen](https://commitizen.github.io/cz-cli/)                                    |

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

| コードレビュー                    | [reviewdog](https://github.com/reviewdog/reviewdog)                                   |

| リリース                          | [semantic-release](https://semantic-release.gitbook.io/semantic-release/)             |

| 依存性更新                        | [Dependabot](https://docs.github.com/ja/code-security/dependabot)                     |

| Lint：Git ステージ                | [lint-staged](https://github.com/okonet/lint-staged)                                  |

| Lint：Git コミットメッセージ      | [commitlint](https://commitlint.js.org/)                                              |

| Lint：クレデンシャル              | [Secretlint](https://github.com/secretlint/secretlint)                                |

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

| Lint：テキスト（散文）            | [textlint](https://textlint.github.io/)                                               |

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

| Lint：JSON、その他                | [Prettier](https://prettier.io/)                                                      |

| Lint：GitHub Actions ワークフロー | [actionlint](https://github.com/rhysd/actionlint)                                     |

| Lint：GitHub PR タイトル          | [semantic-pull-request](https://github.com/marketplace/actions/semantic-pull-request) |

### コミュニティスタンダード

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

### セキュリティ

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

なぜ `Private vulnerability reporting` と `Code scannig alerts` 機能が有効になっていないのでしょうか？それは、前者はベータ機能であり、このリポジトリにはスキャン対象となるコードが存在しないためです！もちろん、あなたのプロジェクトに応じてこれらをセットアップすることもできます。

### トラブルシューティング

この方法で問題が解決しない場合、[issue を作成](https://github.com/haru52/base_template_ja/issues/new/choose)してください。

#### CI が失敗する

1. `https://github.com///settings/actions` を開く

2. `Workflow permissions` 設定の `Read and write permissions` オプションが選択されていない場合はこれを選択

3. `Allow GitHub Actions to approve pull requests` がチェックさていない場合はこれをチェック

4. `Save` ボタンをクリック

### 既存リポジトリへのテンプレート適用

[Base Template CLI][base-template-cli] をご利用ください。

### 言語

- [English](https://github.com/haru52/base_template)（本家）

- 日本語（当リポジトリ）

## バージョニングポリシー

[セマンティック バージョニング 2.0.0](https://semver.org/lang/ja/spec/v2.0.0.html)

## ライセンス

[WTFPL](LICENSE)

## コントリビューション

[コントリビューティングガイドライン](https://haru52.github.io/base_template_ja/CONTRIBUTING.html)

## ドキュメント

[ドキュメント | base_template_ja](https://haru52.github.io/base_template_ja/)

## 作者

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

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