php/archived-frankenphp
1
0
Fork 0
mirror of https://github.com/php/frankenphp.git synced 2026-03-24 00:52:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve contribution guide

Browse Source
This commit is contained in:
Kévin Dunglas
2022-10-15 18:42:24 +02:00
parent d4fce0d678
commit 291b9464bc
2 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
CONTRIBUTING.md
View File

@@ -4,14 +4,15 @@
go test -race -v ./...
## Testing in live
## Debugging
### With Docker (Linux)
Prepare a dev Docker image:
Build the dev Docker image:
docker build -t frankenphp .
docker run -p 8080:8080 -p 443:443 -v $PWD:/go/src/app -it frankenphp bash
docker build -t frankenphp-dev Dockerfile.dev
docker run -p 8080:8080 -p 443:443 -v $PWD:/go/src/app -it frankenphp-dev bash
The image contains the usual development tools (Go, GDB, Valgrind, Neovim...).
#### Caddy module
Build Caddy with the FrankenPHP Caddy module:

1
README.md
View File

@@ -35,3 +35,4 @@ Go to `https://localhost`, and enjoy!
* [Demo app (Symfony) and benchmarks](https://github.com/dunglas/frankenphp-demo)
* [Compile from sources](docs/compile.md)
* [Go library documentation](https://pkg.go.dev/github.com/dunglas/frankenphp)
* [Contributing and debugging](CONTRIBUTING.md)