レポジトリ命名規則

このドキュメントは、GitHub 上で新しくレポジトリを作成する際の 命名規則 を定めたものです。
明確で統一された命名方式により、プロジェクトの整理性・検索性・可読性が向上し、運用をスムーズにします。

---

🎯 基本方針

• 名前を見ただけで 用途・対象 がわかること
• 小文字・ハイフン区切り（kebab-case） を使用
• 英語ベース（日本語は不可）
• 省略語ではなく 明確な単語を使用する
• 同一組織の中で命名の揺れが出ないよう統一する

---

📌 命名ルール（基本）

レポジトリ名は、以下のテンプレートをベースに作成します：

{project}-{scope}-{tech}

用語定義

要素	説明	例
project	プロジェクト名・サービス名	vrstv, company-site
scope	レポジトリの役割・対象範囲	web, api, cms, infra
tech	技術スタック（任意）	nextjs, bun, cloudflare

🔹 例（Next.js Web フロント）

vrstv-web-nextjs

🔹 例（Cloudflare Workers API）

vrstv-api-cloudflare

🔹 例（デザインシステム）

design-system-react

---

🧩 よく使う scope 候補

scope	用途例
web	フロントエンド（Web）
app	ネイティブアプリ、ハイブリッドアプリ
api	API サーバー
infra	IaC（Terraform, Pulumi など）
cms	microCMS / Strapi など
docs	ドキュメント類
design	UI ライブラリ / デザインシステム

scope は増やして OK。ただし 一度追加したら組織内で統一して使い続けること。

---

📦 技術スタック表記（任意だが推奨）

tech	技術
nextjs	Next.js
react	React（汎用）
node	Node.js
bun	Bun
cloudflare	Cloudflare Pages / Workers
go	Go
python	Python
swift	Swift（iOS）

---

🛑 禁止事項

• ❌ 大文字を使う → VRSTV-Web
• ❌ アンダースコア → vrstv_web
• ❌ 日本語・全角 → 会社サイト
• ❌ 省略しすぎた名前 → vs-api
• ❌ 技術名だけのレポジトリ → react-app
• ❌ 意味がわからない略語 → wtf-lp-sys

---

⭐ 推奨命名テンプレート

1. Web サイト

{project}-web-nextjs

例）

vrstv-web-nextjs
company-site-web-nextjs

---

2. API（BFF / サーバー）

{project}-api-node
{project}-api-cloudflare

例）

vrstv-api-cloudflare

---

3. ドキュメント

{project}-docs

例）

vrstv-docs

---

4. デザインシステム

design-system-react

---

5. インフラ構成

{project}-infra-terraform

---

🗂️ アーカイブの命名

レポジトリをアーカイブする場合は、以下の命名を使います：

arch_{original-name}

例）

arch_vrstv-web-nextjs
arch_company-site-web-nextjs

※詳細は → レポジトリのアーカイブについて

---

🧭 命名フローチャート（簡易）

1. プロジェクト名は？ → {project}
2. 役割は？ → web, api, cms, infra, docs など
3. 技術スタックを含めるか？ → nextjs, cloudflare, bun, etc
4. kebab-case に変換
5. 完成！

---

この命名規則に従うことで、組織内すべてのレポジトリが 一貫性・意味の明確さ・検索性 を持つようになります。