Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) · 1.72 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. The easiest way to apply the conventions is to install PHP CS Fixer.
  • 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 main 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

First, you need to configure the environment variables. Copy the default phpunit config (phpunit.xml.dist) into "gitignored" phpunit.xml to avoid committing sensitive data:

$ cp phpunit.xml.dist phpunit.xml

Edit phpunit.xml file, fill the COINBASE_COMMERCE_API_KEY and COINBASE_COMMERCE_WEBHOOK_SECRET env variables according to the data from your Coinbase Commerce account.

Now run phpunit:

$ composer run-script test

Happy coding!