From 569945cd374c13e79c706fbf0d7916db8463e3af Mon Sep 17 00:00:00 2001 From: spawnia Date: Thu, 28 Mar 2019 11:24:06 +0100 Subject: [PATCH] Clarify some bits of CONTRIBUTING.md and unify formatting --- CONTRIBUTING.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8c12d16..399716c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,6 @@ # Contributing to GraphQL PHP ## Workflow - If your contribution requires significant or breaking changes, or if you plan to propose a major new feature, we recommend you to create an issue on the [GitHub](https://github.com/webonyx/graphql-php/issues) with a brief proposal and discuss it with us first. @@ -14,9 +13,10 @@ For smaller contributions just use this workflow: * Check your changes using `composer check-all` * Send a pull request -## Using GraphQL PHP from a Git checkout +## Setup the Development Environment +First, copy the URL of your fork and `git clone` it to your local machine. + ```sh -git clone https://github.com/webonyx/graphql-php.git cd graphql-php composer install ``` @@ -29,28 +29,26 @@ composer install Some tests have annotation `@see it('')`. It is used for reference to same tests in [graphql-js implementation](https://github.com/graphql/graphql-js) with the same description. ## Coding Standard -Coding standard of this project is based on [Doctrine CS](https://github.com/doctrine/coding-standard). To run the inspection: +The coding standard of this project is based on [Doctrine CS](https://github.com/doctrine/coding-standard). +Run the inspections: ```sh ./vendor/bin/phpcs ``` -Auto-fixing: +Apply automatic code style fixes: ```sh ./vendor/bin/phpcbf ``` ## Static analysis -Based on [PHPStan](https://github.com/phpstan/phpstan) +Based on [PHPStan](https://github.com/phpstan/phpstan). ```sh ./vendor/bin/phpstan analyse --ansi --memory-limit 256M ``` - ## Running benchmarks - -Benchmarks are run via phpbench: - +Benchmarks are run via [PHPBench](https://github.com/phpbench/phpbench). ```sh ./vendor/bin/phpbench run . ```