2021-10-13 13:11:14 +00:00
# How to Contribute
2021-07-19 20:57:26 +00:00
Contributions here are more than welcomed! You can contribute to [rector-src ](https://github.com/rectorphp/rector-src ) repository.
2021-10-13 13:11:14 +00:00
## Preparing Local Environment
2021-10-13 13:07:27 +00:00
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
2021-10-13 13:11:14 +00:00
```
2021-10-13 13:07:27 +00:00
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.
2021-10-13 13:11:14 +00:00
For example, to download PHP dependencies:
2021-10-13 13:07:27 +00:00
2021-10-13 13:11:14 +00:00
```bash
docker-compose run php composer install
```
Now you can start using all scripts and work with the code.
## Preparing Pull Request
2021-10-13 13:07:27 +00:00
There 3 rules will highly increase chance to get your PR merged:
2021-07-19 20:57:26 +00:00
- **1 feature per pull-request**
- **new features need tests**
- CI must pass... you can mimic it locally by running
```bash
composer complete-check
```
- Do you need to fix coding standards?
```bash
composer fix-cs
```
2021-10-13 13:11:14 +00:00
We would be happy to accept PRs that follow these guidelines.