Skip to content

Latest commit

 

History

History
53 lines (39 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

53 lines (39 loc) · 1.49 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 for your changes.
  3. Code, test, commit, and push your changes.
  4. Open a pull request detailing your changes. Make sure to follow the template.

Guidelines

  • Ensure that you follow the PSR-1, PSR-4, and PSR-12 coding standards. You can check this by running composer lint.
  • Please strive for a coherent commit history, making sure each individual commit in your pull request is meaningful.
  • If necessary, please rebase to avoid merge conflicts.
  • Remember that we follow SemVer. Therefore, if you are adding any changes to the API, it may only be done in a new major version.
  • Any new functionality or changes should be accompanied by appropriate tests. Please ensure that all tests are passing before submitting a pull request.

Setup

Clone your fork, then install the dev dependencies:

composer install

Lint

Lint your code:

composer test:lint

Types

Check your types:

composer test:types

Unit

Run the unit tests:

composer test:unit

Type Coverage

Check the type coverage:

composer test:type-coverage