概要
言語やフレームワークに依存せず、ほぼあらゆるプロジェクトに共通するリポジトリの設定ファイルなどがあります。それらをまとめたテンプレートリポジトリとして、ベーステンプレートリポジトリ（Base Template Repository）を作りました。
GitHub リポジトリ
英語版（本家）
日本語版
背景
ソフトウェア開発をする中で生産性の低さという課題に直面することがあると思います。開発生産性を低下させる要因の一部として次の 3 点が挙げられます。
- 無駄な作業の多さ
- 句読点の付け方やインデントにおけるスペースの個数など本質的でないコードレビューで疲弊
- リリースや依存ライブラリ更新など毎回同じような単純作業の繰り返しが面倒。特に複数リポジトリを運用する場合に顕著
- コミュニティへの不親切さ
- コントリビュートしようと思っても、開発規約などコントリビューションに必要なドキュメントなどが不足している
- OSS として公開しないリポジトリでも、開発規約などが不明確だと将来の自分が困る
- ボイラープレート設置の繰り返し
- 複数リポジトリで毎回同じ設定ファイル（
.editorconfigなどのボイラープレート）などを設置する作業が辛い
- 複数リポジトリで毎回同じ設定ファイル（
そこで、これらの課題を解決するため、ベーステンプレートリポジトリ（Base Template Repository）の英語版と日本語版を作りました。これは、あらゆるプロジェクトのベースとなるテンプレートリポジトリです。
詳細
ベーステンプレートでは先述の課題 3 点を次のように解決します。
- 開発フロー自動化
- コミュニティスタンダード準拠
- GitHub テンプレートリポジトリ機能
1. 開発フロー自動化
コードレビューやリリースなどの開発フローを自動化することで、人間が無駄な作業に従事するコストを削減します。具体的には以下の通りです。
- あらゆるプロジェクトで共通して必要になるであろう linter などの設定ファイルの設置
- Git コミット時と CI 実行時の lint 自動実行
- Conventional Commits の規約に従ったコミットメッセージの強制
- GitHub Actions による CI/CD 環境
- 自動コードレビュー
- コミットメッセージに基づく自動リリース
- 依存ライブラリなどの自動更新
2. コミュニティスタンダード準拠
コミュニティスタンダード 1 に完全準拠し、コントリビューティングガイドライン（CONTRIBUTING.md）や issue テンプレートなどが設置してあります。これにより、コントリビュートしやすくコミュニティに親切なプロジェクトを実現します。
3. GitHub テンプレートリポジトリ機能
ベーステンプレートは GitHub のテンプレートリポジトリ機能を利用しています。リポジトリ初期化時に空の状態ではなくベーステンプレートの構成を継承することで、ボイラープレート設置コストを大幅に削減します。
その他
ベーステンプレートリポジトリには英語版と日本語版の 2 種類あるので、プロジェクトに応じてお好きな方をご利用ください。例えば OSS として全世界に公開するプロジェクトでは英語版を選択するなどが考えられます。
ご利用の際は GitHub のテンプレートリポジトリ機能を介してご利用いただくのが基本ですが、設定ファイルの一部をコピペするなど部分的な利用でも十分に役立つかと思います。また、ベーステンプレートで採用しているツール群に対して追加・変更・削除を加えるなど、プロジェクトに応じてカスタマイズしていただければと思います。
なお、ライセンスは利用時のクレジット表記すら不要な非常に緩いものを選択しています。なので、商用利用を含めほぼ完全に自由な形でご利用いただけます。
技術スタック
| カテゴリー | ツール |
|---|---|
| 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：英語テキスト（散文） | Vale |
| Lint：日本語テキスト（散文） | textlint |
| Lint：YAML | yamllint |
| Lint：シェルスクリプト | ShellCheck |
| Lint：JSON、その他 | Prettier |
| Lint：GitHub Actions ワークフロー | actionlint |
| Lint：GitHub PR タイトル | semantic-pull-request |
最後に
このベーステンプレートリポジトリが皆さんの開発生産性を向上する一助になれば幸いです 😌