octoleo
/
rector
mirror of https://github.com/rectorphp/rector.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

MD tuning

This commit is contained in:
Tomas Votruba 2021-10-13 14:55:38 +02:00
parent 2acce0ab9b
commit 1dc80df98d
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
CONTRIBUTING.md
View File

@ -1,19 +1,26 @@
## How to Contribute
# How to Contribute
Contributions here are more than welcomed! You can contribute to [rector-src](https://github.com/rectorphp/rector-src) repository.
### Preparing Local Environment
## Preparing Local Environment
If you have PHP 8 and Composer installed locally you can use it straight away. You can validate your environment with:
```bash
composer check-platform-reqs
```
Alternatively you can use Docker runtime. All you need to do is wrap every command with `docker-compose run php`, so commands will be executed inside Docker container.
For example `docker-compose run php composer install` will download PHP dependencies, so you can start using all scripts and work with the code.
For example, to download PHP dependencies:
### Preparing Pull Request
```bash
docker-compose run php composer install
```
Now you can start using all scripts and work with the code.
## Preparing Pull Request
There 3 rules will highly increase chance to get your PR merged:
@ -31,4 +38,4 @@ There 3 rules will highly increase chance to get your PR merged:
composer fix-cs
```
We would be happy to accept PRs that follow these guidelines.
We would be happy to accept PRs that follow these guidelines.