Skip to content

Latest commit

 

History

History
27 lines (21 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

27 lines (21 loc) · 1.13 KB

Contributing Guidelines

Steps

  • Fork the project.
  • Make your feature addition or bug fix.
  • Add tests for it. This is important so we don't break it in a future version unintentionally.
  • Commit just the modifications, do not mess with the composer.json file.
  • Ensure your code is nicely formatted in the PSR-2 style and that all tests pass.
  • Send the pull request.
  • Check that the Travis CI build passed. If not, rinse and repeat. Note: This repo uses Psalm to statically analyze all the code. Psalm runs on all the builds for PHP 5.5+.

NOTE: This repo requires pull-request reviews for all changes on branches bound for production in accordance with Vimeo policy.

Testing locally

To install Psalm and run the full test suite locally, download Composer into the repository and then run:

make install
make

If you use PHP 5.3 or 5.4 locally (which are not supported by the latest version of Psalm), you can skip Psalm by running:

make install_no_psalm
make no_psalm