mirror of
https://github.com/rectorphp/rector.git
synced 2024-06-11 13:42:22 +00:00
2acce0ab9b
* Minimal Docker runtime Allow contributors work on the code without actual PHP8 on their computers. * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md Co-authored-by: Tomas Votruba <tomas.vot@gmail.com>
1.0 KiB
1.0 KiB
How to Contribute
Contributions here are more than welcomed! You can contribute to rector-src repository.
Preparing Local Environment
If you have PHP 8 and Composer installed locally you can use it straight away. You can validate your environment with:
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.
### Preparing Pull Request
There 3 rules will highly increase chance to get your PR merged:
- **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
```
We would be happy to accept PRs that follow these guidelines.