Skip to content

Latest commit

 

History

History
76 lines (59 loc) · 1.23 KB

CONTRIBUTING.md

File metadata and controls

76 lines (59 loc) · 1.23 KB
Raw

CONTRIBUTING

Contributions are welcome, and are accepted via pull requests. Please review these guidelines before submitting any pull requests.

Process

  1. Fork the project
  2. Create a new branch
  3. Code, test, commit and push
  4. Open a pull request detailing your changes. Make sure to follow the template

Guidelines

  • Please ensure the coding style running composer lint.
  • Send a coherent commit history, making sure each individual commit in your pull request is meaningful.
  • You may need to rebase to avoid merge conflicts.
  • Please remember that we follow SemVer.

Setup

Clone your fork, then install the dev dependencies:

composer install

Lint

Lint your code:

composer lint

Tests

Run all tests:

composer test

Check types:

composer test:types

Unit tests:

composer test:unit

Docker Setup

Clone your fork, then install the dev dependencies:

make install

Lint

Lint your code:

make lint

Tests

Run all tests:

make test

Check types:

make test-types

Unit tests:

make test-unit