Skip to content
This repository was archived by the owner on Feb 1, 2023. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
21 lines (11 loc) · 1.06 KB

CONTRIBUTING.md

File metadata and controls

21 lines (11 loc) · 1.06 KB

How to contribute:

  • Fork this repository

  • See base requirements, and install them if needed

  • Install development dependencies with Composer - composer install

  • Make your changes to source files in src/ directory

  • Run PHP_CodeSniffer - vendor/bin/phpcs --standard=phpcs.xml.dist -sp --encoding=utf-8 src/ --report-width=150

  • If it finds any errors or warnings please correct them before moving on to the next step

    (some can be fixed automatically with PHP Code Beautifier and Fixer - vendor/bin/phpcbf --no-patch src/

  • Build phar file by running php build.php

  • Run the run script from inside build/ directory and test your changes

  • If everything works fine push your changes to your fork then create a pull request