Skip to content

Commit 9167091

Browse files
web-flowclaude
andcommitted
docs: restructure SSoT documentation in CONTRIBUTING.md
- Add SSoT concept explanation at the beginning - Add "Document SSoT" section with reference table - Consolidate "Version SSoT" under the same principle - Simplify structure for better readability 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 1d29fe5 commit 9167091

1 file changed

Lines changed: 15 additions & 11 deletions

File tree

EpisodicRAG/CONTRIBUTING.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -361,37 +361,41 @@ git status
361361
- CONTRIBUTING.md - このファイル
362362
- docs/ - 詳細ドキュメント
363363

364-
### バージョン管理
364+
### Single Source of Truth (SSoT) 原則
365365

366-
#### Single Source of Truth (SSoT)
366+
**SSoT(Single Source of Truth)** とは、同じ情報を複数箇所に書かず、正規の定義場所を1つに定めて参照する原則です。変更時のメンテナンス負荷を軽減し、不整合を防止します。
367+
368+
#### ドキュメントのSSoT
369+
370+
| 情報 | SSoT(正規の定義場所) | 参照方法 |
371+
|------|----------------------|----------|
372+
| 用語・概念定義 | [README.md](README.md)(用語集) | `> 📖 詳細: [用語集](../../README.md#セクション名)` |
373+
| フッター | `_footer.md` | 各ドキュメント末尾で統一 |
374+
| 設定仕様 | [api/config.md](docs/dev/api/config.md) | リンクで参照 |
375+
376+
#### バージョンのSSoT
367377

368378
バージョン情報は `scripts/domain/version.py``__version__` が唯一の真実です。
369379

370380
```python
371381
# scripts/domain/version.py
372-
__version__ = "2.3.0" # ← ここを更新
382+
__version__ = "3.0.0" # ← ここを更新
373383
```
374384

375-
#### バージョン同期対象
376-
377385
| ファイル | フィールド | 備考 |
378386
|---------|-----------|------|
379387
| `scripts/domain/version.py` | `__version__` | SSoT(ここを更新) |
380388
| `.claude-plugin/plugin.json` | `version` | 手動同期 |
381389
| `pyproject.toml` | `version` | 手動同期 |
382390

383-
#### pre-commitによる自動チェック
384-
385-
コミット時に `check_version.py` が自動実行され、3箇所のバージョンが一致しているか検証されます。
391+
**pre-commitによる自動チェック**: コミット時に `check_version.py` が自動実行され、3箇所のバージョンが一致しているか検証されます。不一致がある場合はコミットがブロックされます。
386392

387393
```bash
388394
# 手動でチェック
389395
python scripts/check_version.py
390396
```
391397

392-
不一致がある場合はコミットがブロックされます。
393-
394-
#### ドキュメントヘッダーのバージョン
398+
### ドキュメントヘッダーのバージョン
395399

396400
一部ドキュメント(ARCHITECTURE.md, API_REFERENCE.md, TROUBLESHOOTING.md)にはバージョンヘッダーがあります:
397401

0 commit comments

Comments
 (0)