プロジェクト運用ファイルについて

このページでは、リポジトリのルートやドキュメント配下に配置されている、プロジェクト運用に関する主要なファイルについて説明します。

これらのファイルを理解することで、このプロジェクトにどう貢献すればよいか や
どのようなルール・前提でコミュニティが運営されているか を把握できます。

---

リポジトリ直下に置かれる主な運用ファイル

📝 CONTRIBUTING.md

目的
オープンソースプロジェクトにおけるコントリビューター向けのガイドラインを提供するための文書です。

役割

• このプロジェクトに「どう貢献すればよいか」を明示する
• Issue や Pull Request の作成方法
• ブランチ運用ルールやコミットメッセージ規約
• コードレビューの基本的な流れ

配置場所

• プロジェクトのルートディレクトリ（/CONTRIBUTING.md）

関連ドキュメント

• 開発環境のセットアップ
• 作業の進め方
• プルリクエスト

---

🤝 CODE_OF_CONDUCT.md

目的
オープンソースプロジェクトに参加するすべての人の 行動基準 を示し、
健全で安全なコミュニティを維持するための文書です。

誰のためのものか

• コントリビューター
• メンテナー
• 利用者（ユーザー）
• その他、このプロジェクトに関わるすべての人

記載されている内容（例）

• 望ましい行動（敬意・思いやり・建設的なコミュニケーション）
• 許容されない行動（ハラスメント・差別的言動など）
• 規範違反が起きた場合の対応方針
• 連絡先（報告窓口）

配置場所

• プロジェクトのルートディレクトリ（/CODE_OF_CONDUCT.md）

---

🔐 SECURITY.md

目的
ソフトウェアプロジェクトにおける セキュリティ関連のガイドライン を提供するための文書です。

主な内容

• セキュリティ対応の対象となるバージョン範囲
• 脆弱性が見つかったときの 報告方法
  • 公開 Issue ではなく、専用のメールアドレスや窓口への連絡を推奨
• 報告を受けた後の基本的な対応プロセス
  • 受領連絡
  • 調査
  • 修正版（パッチ）の準備
  • 公開前の連絡方針 など

配置場所

• プロジェクトのルートディレクトリ（/SECURITY.md）

---

ドキュメント配下にある関連ページ

ルートディレクトリのメタファイルに加えて、VitePress 上のドキュメントとして
より詳細な情報を提供するためのページも用意しています。

🚀 getting-started/index.md（Getting Started）

目的
このプロジェクトに参加するための 入口ページ です。

• GitHub アカウントの作成案内
• プロジェクト内の主要ドキュメントへのリンク集
• まず読んでほしいファイル・ページの一覧

リンク

• Getting Started

---

🧰 environment.md（開発環境のセットアップ）

目的

• 開発に必要なツールやバージョンをまとめた 環境構築ガイド

内容例

• Node.js / Bun / Git / 推奨エディタ（VSCode など）
• リポジトリの clone 手順
• 依存パッケージのインストール方法
• ローカル開発サーバーの起動方法

リンク

• 開発環境のセットアップ

---

🔄 howtoproceed.md（作業の進め方）

目的

• 日々の開発作業の進め方を統一し、チームでの動き方をわかりやすくする ためのページです。

主な内容

• Issue の確認と担当の決め方
• ブランチの切り方（例：feature/xxx, bugfix/xxx）
• ローカルでの実装・テストの流れ
• 作業完了から PR 作成までの流れ

リンク

• 作業の進め方

---

📥 pullrequest.md（プルリクエスト）

目的

• Pull Request の作り方・書き方・レビューの流れを分かりやすくまとめたページです。

主な内容

• ブランチの push
• GitHub 上で PR を作成する手順
• PR タイトル・本文に含めるべき情報
• レビュー〜マージまでの基本フロー

リンク

• プルリクエスト

---

📦 archiving-repositories.md（レポジトリのアーカイブについて）

目的

• プロジェクトが終了した・保守しなくなった場合の アーカイブ運用ルール を明文化するためのページです。

主な内容

• アーカイブする基準
• アーカイブ前のチェックリスト
• アーカイブ時の命名規則（例：arch_XXX）

リンク

• レポジトリのアーカイブについて

---

📚 term.md（用語集）

目的

• プロジェクト内で頻出する用語をまとめ、
  初めて参加する人でもスムーズに会話に入れるようにするためのページです。

内容例

• Issue / Pull Request / CI / Lint / Archive などの用語解説
• プロジェクト固有の略語や内部用語

リンク

• 用語集

---

どの順番で読めばよいか

新しく参加する人には、以下の順番を推奨します。

1. Getting Started
2. このページ（プロジェクト運用ファイルについて）
3. 開発環境のセットアップ
4. 作業の進め方
5. プルリクエスト
6. 必要に応じて、CODE_OF_CONDUCT.md と SECURITY.md を確認
7. プロジェクトを長期運用する人は レポジトリのアーカイブについて も参照

---

このページは、「このリポジトリにどんなルールファイルがあって、何を見ればよいか」をまとめたハブ になっています。
運用ルールを更新したりファイルを追加した場合は、このページにも追記する運用にすると分かりやすくなります。