Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 1.05 KB

CONTRIBUTING.md

File metadata and controls

41 lines (26 loc) · 1.05 KB

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, to download PHP dependencies:

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:

  • 1 feature per pull-request

  • new features need tests

  • CI must pass... you can mimic it locally by running

    composer complete-check

  • Do you need to fix coding standards?

    composer fix-cs

We would be happy to accept PRs that follow these guidelines.