diff --git a/README.md b/README.md index 4737f82..8acec5b 100644 --- a/README.md +++ b/README.md @@ -76,9 +76,10 @@ - `src/frontend/`: フロントエンド(Vanilla JS / CSS) - `src/backend/`: バックエンド(Rust / Tauri設定 / MCP実装 / LSAエンジン) -- `docs/specification/`: 設計書・仕様書(`mermaid`図解付き) -- `docs/issues/`: GitBucket 連携用 Issue 管理(`.gitignore` 対象) -- `journals/`: 作業記録(日付別、Rule 13に基づく集約管理) +- `docs/specification/`: システム設計書・技術仕様書 +- `docs/workflow/`: プロジェクト運用・管理ルール(Issue管理等) +- `docs/issues/`: 外部 Issue トラッカー同期用(`.gitignore` 対象) +- `journals/`: 作業記録(日付別管理) --- diff --git a/docs/specification/06_development_guide.md b/docs/specification/06_development_guide.md index 2230fd2..a29a7b8 100644 --- a/docs/specification/06_development_guide.md +++ b/docs/specification/06_development_guide.md @@ -42,17 +42,6 @@ - **ログ**: `log::info!` / `log::error!` を使用してください。ログは `src-tauri/logs/` に自動出力されます。 - **テスト**: ロジックの変更後は必ず `scripts/test_mcp_client.mjs` を実行し、既存ツールが壊れていないか確認してください。 -## 6. Issue管理ルール +## 6. ライセンスと貢献 -GitBucket との連携においては、以下のルールに従います。 - -- **同期方向**: 原則として GitBucket が正(Source of Truth)です。 -- **自動同期**: `node tools/scripts/sync_issues.mjs` でローカル Markdown とリモート Issue を同期します。 -- **日英併記の義務化**: - - すべての Issue は**日本語と英語を併記**しなければなりません。 - - 片方の言語だけで記述されている場合は、不足している言語の翻訳を補完してください。 -- **Issueのクローズ**: - - GitBucket API(PATCH)の制約により、スクリプトからの自動クローズは行いません。 - - 作業完了後、ローカル Markdown の `state` を `closed` にして同期スクリプトを実行すると、**手動クローズ用のURL**が表示されます。 - - 表示されたURLからブラウザで手動クローズを行ってください。 -- **Git追跡除外**: `docs/issues/` は `.gitignore` により Git 追跡から除外されています。個々の Issue の更新履歴は GitBucket 側で管理されます。 +TelosDB は MIT ライセンスの下で公開されています。貢献については、プロジェクトルートの `CONTRIBUTING.md`(存在する場合)またはリポジトリの運用方針を参照してください。 diff --git a/docs/workflow/issue_management.md b/docs/workflow/issue_management.md new file mode 100644 index 0000000..dc04e34 --- /dev/null +++ b/docs/workflow/issue_management.md @@ -0,0 +1,25 @@ +# Issue管理ワークフロー (Issue Management Workflow) + +このリポジトリにおける Issue の管理および同期に関する運用ルールです。 + +## 1. 外部トラッカーとの同期 + +本プロジェクトでは、上流の Issue トラッカー (GitHub 互換 API) とローカルの Markdown ファイルを同期させて開発を進めます。 + +- **同期方向**: 原則として上流の Issue トラッカーが正(Source of Truth)です。 +- **自動同期**: `node tools/scripts/sync_issues.mjs` を実行して、リモートの最新状態を `docs/issues/` に反映、またはローカルの新規 Issue をリモートに作成します。 +- **Git追跡除外**: `docs/issues/` は `.gitignore` により Git 追跡から除外されています。 + +## 2. 記述規約 + +- **日英併記の義務化**: + - すべての Issue は**日本語と英語を併記**しなければなりません。 + - 片方の言語だけで記述されている場合は、不足している言語の翻訳を補完してください。 + +## 3. クローズとクリーンアップ + +- **手動クローズ**: + - トラッカー API の制約により、スクリプトからの自動クローズは行いません。 + - 作業完了後、ローカル Markdown の `state` を `closed` にして同期スクリプトを実行すると、手動クローズ用のURLが表示されます。 +- **ローカルの自動削除**: + - 上流トラッカー側で `closed` になった Issue は、同期スクリプト実行時にローカルの Markdown ファイルが自動的に削除されます。 diff --git "a/journals/20260223-0012-\344\273\225\346\247\230\346\233\270\343\201\250\343\203\227\343\203\255\343\202\270\343\202\247\343\202\257\343\203\210\351\201\213\347\224\250\343\203\253\343\203\274\343\203\253\343\201\256\345\210\206\351\233\242.md" "b/journals/20260223-0012-\344\273\225\346\247\230\346\233\270\343\201\250\343\203\227\343\203\255\343\202\270\343\202\247\343\202\257\343\203\210\351\201\213\347\224\250\343\203\253\343\203\274\343\203\253\343\201\256\345\210\206\351\233\242.md" new file mode 100644 index 0000000..bbd05d2 --- /dev/null +++ "b/journals/20260223-0012-\344\273\225\346\247\230\346\233\270\343\201\250\343\203\227\343\203\255\343\202\270\343\202\247\343\202\257\343\203\210\351\201\213\347\224\250\343\203\253\343\203\274\343\203\253\343\201\256\345\210\206\351\233\242.md" @@ -0,0 +1,36 @@ +# 作業報告: 仕様書とプロジェクト運用ルールの分離 + +## 1. 作業実施の理由と指示 + +- **背景**: これまで `docs/specification/` 内の仕様書に、特定のプロジェクト運用ルール(GitBucket 連携や Issue の書き方等)が混在していた。これはシステムの純粋な設計書としてのポータビリティを損なうものである。 +- **意図と指示**: システム本体の「仕様(Specification)」と、その開発リポジトリにおける「作法・運用ルーチン(Workflow/Ops)」を明確にフォルダ単位で分離すること。 + +## 2. 指記内容とその対応 + +- **指摘**: GitBucket 連携を仕様に書くのは筋が違う。 + - **対応**: + - `docs/specification/06_development_guide.md` から Issue 管理に関する記述をすべて削除。 + - 削除した内容を、新設した `docs/workflow/issue_management.md` に移行。 + - README のディレクトリ構成案を、仕様とワークフローを区別する形に更新。 + +## 3. 作業詳細 + +AIエージェントは以下の作業を実行した: + +- `docs/workflow/` ディレクトリ(存在しない場合は作成)に `issue_management.md` を作成。 +- 既存の「日英併記ルール」「自動クリーンアップルール」「手動クローズ手順」を新ドキュメントへ集約。 +- `docs/specification/06_development_guide.md` を、TelosDB エンジンのビルドや拡張に関する純粋な技術ガイドとして再定義。 +- `README.md` の説明を、新構造に合わせて修正。 + +## 4. AI視点での結果 + +```mermaid +graph TD + A[Mixed Docs] --> B{Refactoring} + B --> C[docs/specification: Pure Tech Design] + B --> D[docs/workflow: Project Admin Rules] + C --> E[High Portability] + D --> F[Clear Team Standards] +``` + +この分離により、例えば TelosDB のエンジン部分だけを別のプロジェクトへ持ち出す際に、不要な「GitBucket 用の運用ドキュメント」が設計書に混じり込むことがなくなった。設計書は「システムの作り」を、ワークフローは「開発の進め方」を、それぞれ独立して記述する健全な構成となった。