Added contribution guide

ingenerator · May 14, 2017 · 54771c7 · 54771c7
1 parent 08a28bc
commit 54771c7
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,18 @@
+Contributing
+============
+
+Feel free to fork and improve.
+
+You can run the tests locally using the docker image
+
+```bash
+cd chrome-headless
+docker run --rm -it -v $(pwd):/code registry.gitlab.com/dmore/docker-chrome-headless bash
+```
+
+Then in the shell:
+
+```bash
+composer install
+vendor/bin/phpunit
+```
diff --git a/README.md b/README.md
@@ -46,3 +46,9 @@ default:
                     chrome:
                         api_url: "http://localhost:9222"
 ```
+
+## Contributing
+
+You are encouraged to fork this repository and contribute your own improvements.
+
+See [the contribution guide](CONTRIBUTING.md) for instructions.