Move contributing guide to its own file

This file will be linked to when submitting a pull request on Github.
Also, Github will notify contributors when it changes. There might be
more features I do not know about.
This commit is contained in:
Grégoire Paris 2020-03-21 12:00:05 +01:00
parent 61722923e6
commit e34a9b43cf
No known key found for this signature in database
GPG Key ID: 24D48B8012B116BF
2 changed files with 20 additions and 17 deletions

19
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,19 @@
# How to Contribute
Just follow 3 rules:
- **1 feature per pull-request**
- **New features need tests**
- Tests, coding standards and PHPStan **checks must pass**:
```bash
composer complete-check
```
Do you need to fix coding standards? Run:
```bash
composer fix-cs
```
We would be happy to accept PRs that follow these guidelines.

View File

@ -442,23 +442,7 @@ Use [the `create` command](/docs/RectorRecipe.md).
## How to Contribute
Just follow 3 rules:
- **1 feature per pull-request**
- **New features need tests**
- Tests, coding standards and PHPStan **checks must pass**:
```bash
composer complete-check
```
Do you need to fix coding standards? Run:
```bash
composer fix-cs
```
We would be happy to accept PRs that follow these guidelines.
See [the contribution guide](/CONTRIBUTING.md).
## Run Rector in Docker
You can run Rector on your project using Docker: