Skip to content

Latest commit

 

History

History
45 lines (28 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

45 lines (28 loc) · 1.39 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 follow the PSR-2 Coding Style Guide, enforced by StyleCI.
  • 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.

We have StyleCI setup to automatically fix any code style issues.

Setup

Clone your fork, then install the dev dependencies:

composer update

Tests

Run all tests:

composer test

Static analysis:

composer test:types

Unit tests:

composer test:unit

Our current testsuite involves running phpstan on each individual file in tests/Features with our extension file loaded. The test will fail if PHPStan fails on the given file. There is currently no way for us to assert that larastan will fail for a given test suite, so it is difficult to test for expected failures in analysis.