Skip to content

Commit 2ccc631

Browse files
committed
Added CONTRIBUTING.md and updated README.md
1 parent 1eb2cca commit 2ccc631

File tree

2 files changed

+45
-574
lines changed

2 files changed

+45
-574
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Contributing to GraphQL PHP
2+
3+
## Workflow
4+
5+
If your contribution requires significant or breaking changes, or if you plan to propose a major new feature,
6+
we recommend you to create an issue on the [Github](https://github.com/webonyx/graphql-php/issues) with
7+
a brief proposal and discuss it with us first.
8+
9+
For smaller contributions just use this workflow:
10+
11+
* Fork the project.
12+
* Add your features and or bug fixes.
13+
* Add tests. Tests are important for us.
14+
* Send a pull request
15+
16+
## Using GraphQL PHP from a Git checkout
17+
```
18+
$ git clone https://github.com/webonyx/graphql-php.git
19+
$ cd graphql-php
20+
$ composer install
21+
```
22+
23+
## Running tests
24+
From the project root:
25+
```
26+
$ ./bin/phpunit
27+
```

0 commit comments

Comments
 (0)