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

概要

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

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

動作要件

• GitHub アカウント

インストール

特になし！

利用方法

1. GitHub で当リポジトリのページを開く
2. Use this template ボタンをクリック
3. 作成したリポジトリのファイルをプロジェクトに応じて編集
4. お疲れ様でした！これにて快適な環境でコーディングする準備が整いました 🎉

アップデート

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

アンインストール

特になし。

詳細

技術スタック

カテゴリー	ツール
IDE／エディタ設定	EditorConfig
.gitignore 管理	gibo
Git フック	Husky
Git コミット I/F	Commitizen
CI/CD	GitHub Actions
コードレビュー	reviewdog
リリース	semantic-release
依存性更新	Dependabot
Lint：Git ステージ	lint-staged
Lint：Git コミットメッセージ	commitlint
Lint：クレデンシャル	Secretlint
Lint：Markdown	markdownlint-cli
Lint：テキスト（散文）	textlint
Lint：YAML	yamllint
Lint：JSON、その他	Prettier
Lint：GitHub Actions ワークフロー	actionlint
Lint：GitHub PR タイトル	semantic-pull-request

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

セキュリティ

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

トラブルシューティング

この方法で問題が解決しない場合、issue を作成してください。

CI が失敗する

1. https://github.com/<org>/<repo>/settings/actions を開く
2. Workflow permissions 設定の Read and write permissions オプションが選択されていない場合はこれを選択
3. Allow GitHub Actions to approve pull requests がチェックさていない場合はこれをチェック
4. Save ボタンをクリック

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

Base Template CLI をご利用ください。

言語

• English（本家）
• 日本語（当リポジトリ）

バージョニングポリシー

セマンティック バージョニング 2.0.0

ライセンス

WTFPL

コントリビューション

コントリビューティングガイドライン

ドキュメント

ドキュメント | base_template_ja

作者

haru