mirror of
https://github.com/rectorphp/rector.git
synced 2024-06-26 04:42:36 +00:00
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:
parent
61722923e6
commit
e34a9b43cf
19
CONTRIBUTING.md
Normal file
19
CONTRIBUTING.md
Normal 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.
|
18
README.md
18
README.md
|
@ -442,23 +442,7 @@ Use [the `create` command](/docs/RectorRecipe.md).
|
||||||
|
|
||||||
## How to Contribute
|
## How to Contribute
|
||||||
|
|
||||||
Just follow 3 rules:
|
See [the contribution guide](/CONTRIBUTING.md).
|
||||||
|
|
||||||
- **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.
|
|
||||||
|
|
||||||
## Run Rector in Docker
|
## Run Rector in Docker
|
||||||
You can run Rector on your project using Docker:
|
You can run Rector on your project using Docker:
|
||||||
|
|
Loading…
Reference in New Issue
Block a user