Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

67 lines (46 loc) · 2.24 KB

Contributing

Contributions are welcome and will be fully credited.

We accept contributions via Pull Requests on Github.

Pull Requests

  • PSR-2 Coding Standard - The easiest way to apply the conventions is to install PHP Code Sniffer.

  • Yoda Notation - To avoid a possible mistake assigning a value unintentionally instead of writing a conditional statement.

  • Avoid plural names for arrays - Because plural names and singular only have one or two different characters, are difficult to distinct, and that can originate mistakes. Instead, use same singular name with suffix like Set, List, Collection, Pool, etc.

  • Add tests! - Your patch won't be accepted if it doesn't have tests.

  • Document any change in behaviour - Make sure the README.md and any other relevant documentation are kept up-to-date.

  • Consider our release cycle - We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option.

  • Create feature branches - Don't ask us to pull from your master branch.

  • One pull request per feature - If you want to do more than one thing, send multiple pull requests.

  • Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.

Running Tests

composer test

NOTES

PHP mod xDebug helps debugging code and execute PHPUnit test, but makes composer and other scripts slow. To deactivate. Run next command.

sudo php5dismod -s cli xdebug

And turn on, calling command.

sudo php5enmod -s cli xdebug

Happy coding!