Add README (EN/JA), LICENSE, and CI badge#1
Conversation
Co-authored-by: kaz29 <63869+kaz29@users.noreply.github.com> Agent-Logs-Url: https://github.com/kaz29/phork/sessions/23496cac-047a-4024-a111-d97c741a2102
There was a problem hiding this comment.
Pull request overview
Adds foundational repository documentation and licensing so users can understand, install, and use phork, with bilingual README content and project badges.
Changes:
- Add full English
README.mdwith CI + license badges, usage examples, CLI options, and development notes - Add Japanese translation
README.ja.mdwith cross-links between languages - Add MIT
LICENSE
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| README.md | Adds primary English documentation, badges, usage/examples, options, and dev/Docker sections |
| README.ja.md | Adds Japanese translation of the README with links to/from English |
| LICENSE | Introduces MIT license text for the project |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | `--log=PATH` | *(なし)* | 実行時間ベース分散に使用する過去の JUnit XML ファイルのパス | | ||
| | `--test-dir=PATH` | `tests/` | `*Test.php` ファイルをスキャンするディレクトリ | | ||
| | `--output=PATH` | `--log` と同じ | マージした JUnit XML 結果の出力先パス | |
There was a problem hiding this comment.
--output のデフォルトが --log と同じパスのため、--log だけ指定して --output を省略するとベースラインの JUnit ファイルを上書きします。誤って消さないよう、注意書きや --output を常に指定する推奨を README に明記した方がよいです。
| - **フォールバック対応** – 過去の実行データがない場合は自動的にラウンドロビン方式で分散 | ||
| - **JUnit 出力のマージ** – 各ワーカーの JUnit XML レポートをひとつのファイルにまとめて出力 | ||
| - **CPU コア数の自動検出** – 利用可能な CPU コア数に基づいてワーカー数を自動設定 | ||
| - **PSR-4 対応** – `composer.json` を読み込み、ファイルパスと PHP クラス名を正しくマッピング |
There was a problem hiding this comment.
特徴の「PSR-4 対応」は composer.json の PSR-4 マップ全般に対応している印象になりますが、現状の実装は namespace => ディレクトリが文字列 1 つの場合のみ想定で、Composer が許容する複数ディレクトリ（配列）形式は扱えません。互換性の範囲を README 側で明確にした方がよいです。
| - **PSR-4 対応** – `composer.json` を読み込み、ファイルパスと PHP クラス名を正しくマッピング | |
| - **PSR-4 対応（単一ディレクトリのみ）** – `composer.json` の PSR-4 設定から「namespace => ディレクトリ」が文字列 1 つで指定されている場合のみを対象に、ファイルパスと PHP クラス名をマッピング（複数ディレクトリ［配列］指定は未対応） |
| | Option | Default | Description | | ||
| |---|---|---| | ||
| | `--workers=N` | auto (CPU cores) | Number of parallel worker processes | |
There was a problem hiding this comment.
The CLI options table is formatted with a double leading pipe (|| ...) which creates an empty first column in GitHub Markdown. Use a standard table header/separator with a single leading | so the table renders as intended.
| | `--output=PATH` | same as `--log` | Path to write the merged JUnit XML result | | ||
|
|
There was a problem hiding this comment.
--output defaults to the same path as --log, which will overwrite the baseline JUnit file if users pass --log but omit --output. The docs should call this out explicitly (or recommend always setting --output) to avoid accidental data loss.
| | `--output=PATH` | same as `--log` | Path to write the merged JUnit XML result | | |
| | `--output=PATH` | same as `--log` (can overwrite baseline) | Path to write the merged JUnit XML result | | |
| > **Warning:** If you specify `--log` but omit `--output`, the merged JUnit XML will be written to the same path as `--log`, overwriting your baseline file. To avoid accidental data loss, it is recommended to always set `--output` explicitly. |
| - **Graceful fallback** – uses round-robin distribution when no prior runtime data is available | ||
| - **Merged JUnit output** – combines per-worker JUnit XML reports into a single file | ||
| - **Auto CPU detection** – automatically picks the number of workers based on available CPU cores | ||
| - **PSR-4 aware** – reads `composer.json` to correctly map file paths to PHP class names |
There was a problem hiding this comment.
The feature list claims full “PSR-4 aware” class mapping from composer.json, but the current implementation only supports a single directory string per namespace and won’t handle Composer’s allowed array-of-directories form. Consider clarifying this limitation in the docs to avoid overpromising compatibility.
| - **PSR-4 aware** – reads `composer.json` to correctly map file paths to PHP class names | |
| - **Basic PSR-4 mapping** – reads simple PSR-4 mappings in `composer.json` (one directory per namespace) to map file paths to PHP class names |
| | オプション | デフォルト | 説明 | | ||
| |---|---|---| | ||
| | `--workers=N` | 自動（CPU コア数） | 並列ワーカープロセスの数 | |
There was a problem hiding this comment.
The CLI options table is formatted with a double leading pipe (|| ...) which creates an empty first column in GitHub Markdown. Use a standard table header/separator with a single leading | so the table renders as intended.
- Update copyright year to 2026 and holder to GitHub profile URL - Add --dev flag to composer require in both READMEs - Add database isolation section with TEST_TOKEN usage Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The repository had no meaningful documentation or license file — only a 9-byte README stub.
Changes
LICENSE— MIT license forkaz29README.md(English, default) — Full project docs including:--workers,--log,--test-dir,--output)README.ja.md(Japanese) — Full Japanese translation ofREADME.mdwith link back to EnglishOriginal prompt
⌨️ Start Copilot coding agent tasks without leaving your editor — available in VS Code, Visual Studio, JetBrains IDEs and Eclipse.