graphql-php/CONTRIBUTING.md

34 lines
841 B
Markdown
Raw Normal View History

# Contributing to GraphQL PHP
## Workflow
If your contribution requires significant or breaking changes, or if you plan to propose a major new feature,
2018-04-15 11:38:16 +03:00
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.
For smaller contributions just use this workflow:
* Fork the project.
* Add your features and or bug fixes.
* Add tests. Tests are important for us.
* Send a pull request
## Using GraphQL PHP from a Git checkout
2018-07-10 00:51:08 +03:00
```sh
git clone https://github.com/webonyx/graphql-php.git
cd graphql-php
composer install
```
## Running tests
2018-07-10 00:51:08 +03:00
```sh
./vendor/bin/phpunit
```
2018-07-10 00:51:08 +03:00
## Coding Standard
Coding standard of this project is based on [Doctrine CS](https://github.com/doctrine/coding-standard). To run the inspection:
```sh
./vendor/bin/phpcs
```