Skip to content

docs: README を英語版にし、日本語版を README.ja.md として残す #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
takecchi merged 1 commit into from
Aug 21, 2026
Merged

docs: README を英語版にし、日本語版を README.ja.md として残す #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .claude/rules/workflow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ CI（`.github/workflows/ci.yml`）は push / PR で `lint → typecheck → test
| `docs/PRD.md` | 要件・受け入れシナリオ（歴史的資料寄り） | 要件が変わったとき |
| `docs/TASKS.md` / `docs/REFACTORING.md` | Phase 単位の作業計画と DoD | 進捗に合わせてチェックボックス更新 |
| `docs/RELEASE.md` | npm 配信手順（Trusted Publishing） | 配信フローが変わったとき |
| `README.md` | **利用者向け**の説明（設定・使い方） | ユーザー可視の挙動・設定が変わったとき |
| `README.ja.md` | **利用者向け**の説明（設定・使い方）の**原本**（日本語） | ユーザー可視の挙動・設定が変わったとき |
| `README.md` | 同じ内容の**英語版**（npm / GitHub の顔） | `README.ja.md` を直したら**必ず対で**更新 |

- **ドキュメントと実装が乖離したら、docs/ を先に直してから実装する。**
- Phase 作業（TASKS.md / REFACTORING.md）は Phase 順に進め、**DoD を満たしてから次へ**。
Expand Down Expand Up @@ -56,7 +57,7 @@ CI（`.github/workflows/ci.yml`）は push / PR で `lint → typecheck → test
- [ ] `core/i18n.ts` の **ja と en 両方**（片方だけ足すと型エラー / `i18n.spec.ts` で落ちる）
- [ ] 対応する co-located `*.spec.ts` と、必要なら `tests/*.test.tsx`
- [ ] `docs/ARCHITECTURE.md`（責務・状態機械を変えたとき）
- [ ] `README.md`（ユーザー可視の設定・キー操作・コマンドを変えたとき）
- [ ] `README.ja.md` と `README.md`（**両方**。ユーザー可視の設定・キー操作・コマンドを変えたとき）
- [ ] `docs/TASKS.md` のチェックボックス / 実績メモ

## 動作確認
Expand Down
4 changes: 2 additions & 2 deletions .claude/skills/add-config-option/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ export interface CodivaConfig {

## 5. ドキュメント

- **ユーザー可視なら `README.md`「設定」節を更新**（既定値と選択肢の意味まで書く）。
- **ユーザー可視なら `README.ja.md` と `README.md` の「設定」節を更新**（既定値と選択肢の意味まで書く。日本語が原本・英語は対で必ず更新）。
- 設計判断（なぜその既定か）は `docs/ARCHITECTURE.md`、SDK options に関わるなら
`docs/TECH_NOTES.md` の Options 節。

Expand All @@ -85,5 +85,5 @@ export interface CodivaConfig {
- [ ] 合成ルート（`index.tsx` / `bootstrap/*`）での配線
- [ ] TUI から変える場合: manager の get/set + `onXChange` + マージ保存 + コマンド
- [ ] `core/config.spec.ts`（テーブル）＋関連 spec
- [ ] README の設定表（ユーザー可視なら必須）
- [ ] README の設定表（`README.ja.md` + `README.md` の両方。ユーザー可視なら必須）
- [ ] `npm run lint` / `npm run typecheck` / `npm test`
4 changes: 2 additions & 2 deletions .claude/skills/add-slash-command/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ const commands = useCommandRunner(

## 5. ドキュメント

- ユーザー可視なので `README.md` のコマンド説明を更新する。
- ユーザー可視なので `README.ja.md`（原本）と `README.md`（英語版）のコマンド説明を**両方**更新する。
- キー操作やフッタヒントが変わるなら `docs/ARCHITECTURE.md` の UI 節も直す。

## チェックリスト
Expand All @@ -72,5 +72,5 @@ const commands = useCommandRunner(
- [ ] `Messages['command']` の ja / en 両方
- [ ] 実装するビューの `useCommandRunner` ハンドラ（＋必要なら `describeOverrides`）
- [ ] `commands.spec.ts` + `tests/commands.test.tsx`
- [ ] README（＋必要なら docs/）
- [ ] README（`README.ja.md` + `README.md` の両方。＋必要なら docs/）
- [ ] `npm run lint` / `npm run typecheck` / `npm test`
Loading
Loading