Skip to content
This repository was archived by the owner on Aug 16, 2022. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (24 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

44 lines (24 loc) · 1.74 KB

Contributing

Contributions are welcome and will be fully credited.

We accept contributions via Pull Requests on Github.

Pull Requests

  • Styling - Code styling is enforced using StyleCI recommended settings. Generally following PSR-2 Coding Standard will keep you close to right, and StyleCI will do the rest.

  • 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

Unit Tests

To run only the unit tests, use the following command

$ composer test

Integration Tests

Integration tests require valid API keys for SparkPost, SendGrid and Postmark. Because of the nature of email delivery, the integration tests will only be run on trusted PRs, those created directly within the project.

$ composer test-integrations

Happy coding!