octoleo/rector
1
1
Fork 0
mirror of https://github.com/rectorphp/rector.git synced 2024-06-08 04:10:51 +00:00
Code Issues Packages Projects Releases Wiki Activity
aceb0e8a93
rector/CONTRIBUTING.md
kenjis 368dbb048c
docs: fix instruction in CONTRIBUTING.md (#2470) 
* docs: fix instruction

bash-3.2$ composer check-platform-reqs
No vendor dir present, checking platform requirements from the lock file

In Locker.php line 331:

  [LogicException]
  No lockfile found. Unable to read locked packages

* phpstan

Co-authored-by: Abdul Malik Ikhsan <samsonasik@gmail.com>
2022-06-10 07:49:18 +02:00

1.3 KiB
Raw Blame History

How to Contribute

Contributions here are more than welcomed! You can contribute to rector-src repository or one of extension packages.

Preparing Local Environment

  1. Fork the rector/rector-src repository and clone it
git clone git@github.com:<your-name>/rector-src.git
cd rector-src
  1. We use PHP 8.1 and composer

Install dependencies and verify your local environment:

composer update
composer check-platform-reqs

Note: using Docker for contributing is strongly discouraged, as it requires extra knowledge of composer internals.

Then you can start working with the code 👍


Do you want to contribute a failing test? This tutorial will sow you how

Preparing Pull Request

There 3 steps will make your pull-request easy to merge:

  • 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.