Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (18 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

33 lines (18 loc) · 1.48 KB
Raw

Contributing

Contributions are welcome and will be fully credited.

We accept contributions via Pull Requests on Github.

Pull Requests

  • PSR-12 Coding Standard - Check the code style with $ composer lint and fix it with $ composer fix. Static analysis must pass too: $ composer analyse.

  • 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

You will need an install of Composer before continuing.

$ composer install && composer test

The pty tests need socat (brew install socat / apt install socat); they are skipped when it is missing.

Happy coding!