diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000000..4c40423db41 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. diff --git a/README.md b/README.md index bf9788fc098..05cbb84ffe2 100644 --- a/README.md +++ b/README.md @@ -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: