Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (41 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

56 lines (41 loc) · 1.33 KB

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 with a brief proposal and discuss it with us first.

For smaller contributions just use this workflow:

  • Fork the project.
  • Add your features and or bug fixes.
  • Add tests. Tests are important for us.
  • Check your changes using composer check-all
  • Send a pull request

Using GraphQL PHP from a Git checkout

git clone https://github.com/webonyx/graphql-php.git
cd graphql-php
composer install

Running tests

./vendor/bin/phpunit

Some tests have annotation @see it('<description>'). It is used for reference to same tests in graphql-js implementation with the same description.

Coding Standard

Coding standard of this project is based on Doctrine CS. To run the inspection:

./vendor/bin/phpcs

Auto-fixing:

./vendor/bin/phpcbf

Static analysis

Based on PHPStan

./vendor/bin/phpstan analyse --ansi --memory-limit 256M

Running benchmarks

Benchmarks are run via phpbench:

./vendor/bin/phpbench run .