Skip to content

Latest commit

 

History

History
46 lines (27 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

46 lines (27 loc) · 1.51 KB
Raw

#Contributing

Contributions are welcome and will be fully credited.

Contributions can be made via a Pull Request on Github.

##Pull Requests

  • PSR-2 Coding Standard - PHP CS Fixer is included as a dev dependency. Make sure you run bin/php-cs-fixer fix before committing your code.

  • Add specs where appropriate - PHPSpec

  • Add examples for new features - Behat

  • Document any change in behavior - 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 Specs

bin/phpspec run

##Running Examples

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

export MOCK_SERVER_PORT=3000
cd features/bootstrap/server
npm install
node server.js

Once the server is running you should be able to run Behat from the project directory:

bin/behat