frankenphp/docs/ja/CONTRIBUTING.md

コントリビューション

PHPのコンパイル

Dockerを使用する場合（Linux）

開発用Dockerイメージをビルドします：

docker build -t frankenphp-dev -f dev.Dockerfile .
docker run --cap-add=SYS_PTRACE --security-opt seccomp=unconfined -p 8080:8080 -p 443:443 -p 443:443/udp -v $PWD:/go/src/app -it frankenphp-dev

このイメージには通常の開発ツール（Go、GDB、Valgrind、Neovimなど）が含まれており、PHP設定ファイルは以下の場所に配置されます。

• php.ini: /etc/frankenphp/php.ini 開発用のプリセットが適用されたphp.iniファイルがデフォルトで提供されます。
• 追加の設定ファイル: /etc/frankenphp/php.d/*.ini
• PHP拡張モジュール: /usr/lib/frankenphp/modules/

お使いのDockerのバージョンが23.0未満の場合、dockerignoreパターンの問題によりビルドに失敗する可能性があります。以下のように.dockerignoreにディレクトリを追加してください。

 !testdata/*.php
 !testdata/*.txt
+!caddy
+!internal

Dockerを使用しない場合（LinuxおよびmacOS）

ソースからのコンパイル手順に従い、--debug設定フラグを渡してください。

テストスイートの実行

go test -tags watcher -race -v ./...

Caddyモジュール

FrankenPHPのCaddyモジュール付きでCaddyをビルドします：

cd caddy/frankenphp/
go build -tags watcher,brotli,nobadger,nomysql,nopgx
cd ../../

FrankenPHPのCaddyモジュール付きでCaddyを実行します：

cd testdata/
../caddy/frankenphp/frankenphp run

サーバーは127.0.0.1:80で待ち受けています：

Note

Dockerを使用している場合は、コンテナのポート80をバインドするか、コンテナ内で実行する必要があります。

curl -vk http://127.0.0.1/phpinfo.php

最小構成のテストサーバー

最小構成のテストサーバーをビルドします：

cd internal/testserver/
go build
cd ../../

テストサーバーを実行します：

cd testdata/
../internal/testserver/testserver

サーバーは127.0.0.1:8080で待ち受けています：

curl -v http://127.0.0.1:8080/phpinfo.php

Dockerイメージをローカルでビルドする

bakeプランを出力します：

docker buildx bake -f docker-bake.hcl --print

amd64用のFrankenPHPイメージをローカルでビルドします：

docker buildx bake -f docker-bake.hcl --pull --load --set "*.platform=linux/amd64"

arm64用のFrankenPHPイメージをローカルでビルドします：

docker buildx bake -f docker-bake.hcl --pull --load --set "*.platform=linux/arm64"

arm64とamd64用のFrankenPHPイメージをスクラッチからビルドしてDocker Hubにプッシュします：

docker buildx bake -f docker-bake.hcl --pull --no-cache --push

静的ビルドでのセグメンテーション違反のデバッグ

1. GitHubからFrankenPHPバイナリのデバッグ版をダウンロードするか、デバッグシンボルを含む独自の静的ビルドを作成します：

   docker buildx bake \
       --load \
       --set static-builder.args.DEBUG_SYMBOLS=1 \
       --set "static-builder.platform=linux/amd64" \
       static-builder
   docker cp $(docker create --name static-builder-musl dunglas/frankenphp:static-builder-musl):/go/src/app/dist/frankenphp-linux-$(uname -m) frankenphp
   

2. 現在使用しているfrankenphpを、デバッグ版のFrankenPHP実行ファイルに置き換えます

3. 通常通りFrankenPHPを起動します（あるいは、GDBで直接FrankenPHPを開始することもできます：gdb --args frankenphp run）

4. GDBでプロセスにアタッチします：

   gdb -p `pidof frankenphp`
   

5. 必要に応じて、GDBシェルでcontinueと入力します

6. FrankenPHPをクラッシュさせます

7. GDBシェルでbtと入力します

8. 出力結果をコピーします

GitHub Actionsでのセグメンテーション違反のデバッグ

1. .github/workflows/tests.ymlを開きます

2. PHPデバッグシンボルを有効にします

       - uses: shivammathur/setup-php@v2
         # ...
         env:
           phpts: ts
   +       debug: true
   

3. tmateを有効にしてコンテナに接続できるようにします

       - name: Set CGO flags
         run: echo "CGO_CFLAGS=$(php-config --includes)" >> "$GITHUB_ENV"
   +   - run: |
   +       sudo apt install gdb
   +       mkdir -p /home/runner/.config/gdb/
   +       printf "set auto-load safe-path /\nhandle SIG34 nostop noprint pass" > /home/runner/.config/gdb/gdbinit
   +   - uses: mxschmitt/action-tmate@v3
   

4. コンテナに接続します

5. frankenphp.goを開きます

6. cgosymbolizerを有効にします

   -	//_ "github.com/ianlancetaylor/cgosymbolizer"
   +	_ "github.com/ianlancetaylor/cgosymbolizer"
   

7. モジュールを取得します：go get

8. コンテナ内で、GDBなどを使用できます：

   go test -tags watcher -c -ldflags=-w
   gdb --args frankenphp.test -test.run ^MyTest$
   

9. バグが修正されたら、これらの変更をすべて元に戻します

その他の開発リソース

• uWSGIでのPHP埋め込み
• NGINX UnitでのPHP埋め込み
• Go言語でのPHP埋め込み (go-php)
• Go言語でのPHP埋め込み (GoEmPHP)
• C++でのPHP埋め込み
• Sara Golemon 著『Extending and Embedding PHP』
• TSRMLS_CCとは何か？
• SDL バインディング

Docker関連リソース

• Bakeファイル定義
• docker buildx build

便利なコマンド

apk add strace util-linux gdb
strace -e 'trace=!futex,epoll_ctl,epoll_pwait,tgkill,rt_sigreturn' -p 1

ドキュメントの翻訳

新しい言語でドキュメントとサイトを翻訳するには、 以下の手順で行ってください。

1. このリポジトリのdocs/ディレクトリに、言語の2文字ISOコードを名前にした新しいディレクトリを作成します
2. docs/ディレクトリのルートにある全ての.mdファイルを新しいディレクトリにコピーします（翻訳のソースとして常に英語版を使用してください。英語版が最新版だからです）
3. ルートディレクトリからREADME.mdとCONTRIBUTING.mdファイルを新しいディレクトリにコピーします
4. ファイルの内容を翻訳しますが、ファイル名は変更せず、> [!で始まる文字列も翻訳しないでください（これはGitHub用の特別なマークアップです）
5. 翻訳でプルリクエストを作成します
6. サイトリポジトリで、content/、data/、i18n/ディレクトリの翻訳ファイルをコピーして翻訳します
7. 作成されたYAMLファイルの値を翻訳します
8. サイトリポジトリでプルリクエストを開きます