01. ルートディレクトリ
このドキュメントでは、DevBlueprint
リポジトリのルートディレクトリ(一番上の階層)に配置される、主要なファイルやフォルダの役割について説明します。
一貫したフォルダ構成は、プロジェクトの理解を助け、必要な情報へのアクセスを容易にします。
主要なファイルとフォルダ
プロジェクトのルートディレクトリ直下には、以下の主要な要素が存在します。
.
├── .github/ # (A) GitHub連携と自動化
├── .gemini/ # (B) AIアシスタントの設定
├── .vscode/ # (C) VSCodeエディタ固有の設定 (任意)
├── Docs/ # (D) 全てのドキュメントソース
├── scripts/ # (E) プロジェクト用の補助スクリプト (任意)
├── .gitignore # (F) Gitの追跡対象外ファイルを指定
├── DevBlueprint.sln # (G) Visual Studio ソリューションファイル (任意)
├── LICENSE # (H) プロジェクトのライセンス情報
├── mkdocs.yml # (I) ドキュメントサイトの全体設定
└── README.md # (J) プロジェクト全体の概要説明
(A) .github/
GitHubとの連携、特にGitHub ActionsによるCI/CD(自動化)や、Issue/Pull Requestのテンプレートなどを格納する、GitHubが予約した特別なフォルダです。
* workflows/
: GitHub Actionsのワークフロー定義ファイル(.yml
)を格納します。
* ISSUE_TEMPLATE/
: Issue作成時に使用するテンプレートを格納します。
(B) .gemini/
Google Gemini Code Assistのような、AIコーディングアシスタントにプロジェクト固有のコーディングスタイルを教えるための設定ファイルを格納します。
* styleguide.md
: このプロジェクトのコーディング規約をAIが理解できる形式で記述します。
(C) .vscode/
(任意)
Visual Studio Codeエディタを使用する開発者間で、設定を共有するためのフォルダです。
* settings.json
: ワークスペース固有の設定(例: フォーマッターの指定)を記述します。
* extensions.json
: このプロジェクトで推奨されるVSCode拡張機能をリストアップします。
(D) Docs/
プロジェクトに関する全てのドキュメントのソースファイルを格納するメインフォルダです。このフォルダ内のMarkdownファイルが、ドキュメントサイトとして公開されます。 詳細は 02.Docsフォルダ を参照してください。
(E) scripts/
(任意)
プロジェクトのセットアップ、ドキュメント生成、定型的なタスクの自動化などを行うための、補助的なスクリプトを格納します。 Node.js、Python、シェルスクリプトなどで実装されます。
(F) .gitignore
Gitのバージョン管理から除外したいファイルやフォルダ(例: bin/
, obj/
, node_modules/
など)を指定するファイルです。
(G) DevBlueprint.sln
(任意)
Visual Studioでプロジェクトを開くためのソリューションファイルです。
Docs
フォルダをプロジェクトとして管理することで、VSのAIチャット機能にドキュメントを認識させる、といった目的で使用します。
(H) LICENSE
このプロジェクトが準拠するライセンスの全文を記述したファイルです。DevBlueprint
はMIT Licenseを採用しています。
(I) mkdocs.yml
静的サイトジェネレータMkDocs
の設定ファイルです。サイトのタイトル、テーマ、ナビゲーション構造などを定義します。
(J) README.md
リポジトリの「顔」となるファイルです。GitHubでリポジトリのトップページを開いたときに最初に表示され、プロジェクトの概要や使い方、ドキュメントサイトへのリンクなどを記述します。