Browse Source

docs: improve contribution guide

Kévin Dunglas 2 years ago
parent
commit
291b9464bc
2 changed files with 6 additions and 4 deletions
  1. 5 4
      CONTRIBUTING.md
  2. 1 0
      README.md

+ 5 - 4
CONTRIBUTING.md

@@ -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 - 0
README.md

@@ -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)