Couple

Port of ryansmith94/couple from JS to PHP. A library for coupling two objects together. This is useful for nested pattern matching.


If you have a bug, enhancement, or question you can post it in the issues, however, please see the guidelines before doing so. You may also ask questions and chat on Gitter.

Users

Documentation can be found in the docs directory. Install using composer require ht2/couple.

Developers

You may contribute to this project via issues and pull request, however, please see the guidelines before doing so.

Getting Started

1. Fork the repository.
2. Clone your forked version of the repository.
3. Run composer install.
4. Change the code.
5. See Testing below for more information.
6. Repeat from Step 4 or continue to step 7.
7. Commit and push your changes to Github.
8. Create a pull request on Github (ensuring that you follow the guidelines).

Directory Structure

• src - Source code written in PHP.
• tests - Testing code written in PHP.
• docs - Documentation written in "Github Flavoured Markdown".

Testing

You should try to ensure that ./vendor/bin/phpunit tests runs without any errors before submitting a pull request.