Skip to content

Latest commit

 

History

History
53 lines (31 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

53 lines (31 loc) · 1.85 KB

Contributing

Contributions are welcome!

Contributions can be made via a Pull Request on GitHub.

Reporting an Issue

Please report issues via the issue tracker on GitHub. For security-related issues, please email the maintainer directly.

Pull Requests

  • PSR-2 Coding Standard - PHP CS Fixer. Make sure you run composer run-script fix before committing your code.

  • Add specs where appropriate - PHPSpec

  • Add examples for new features - Behat

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

  • Create topic branches - i.e feature/some-awesome-feature.

  • One pull request per feature

  • 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 the specs

composer run-script specs

Running the examples

To run the examples you need to make sure the mock server is running. The mock server requires the MOCK_SERVER_PORT environment variable to be set:

export MOCK_SERVER_PORT=3000

Once the MOCK_SERVER_PORT environment variable is set, start the mock server:

composer run-script mock-server

You should now be able to run the examples:

composer run-script examples

If you started the mock server in a different terminal window / tab to where you are running the examples, you will need to set the MOCK_SERVER_PORT environment variable again.