Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (21 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

34 lines (21 loc) · 1.35 KB

CONTRIBUTING

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

Guidelines

  • Please follow the PSR-12 Coding Standard.
  • Ensure that the current tests pass, and if you've added something new, add the tests where relevant.
  • Send a coherent commit history, making 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.
  • You may also need to rebase to avoid merge conflicts.

Running Tests

You will need to install Composer before continuing.

First, install the dependencies:

$ composer install

Then run phpunit and code sniffer:

$ composer check

If the test suite passes on your local machine you should be good to go.

PRO TIP: Install the git hooks by running composer githooks. This will make git run phpunit and code sniffer before committing or pushing to remote.

Documentation

If you are adding a new feature or changing functionalities please also update the proper documentation under the ./docs folder. We are using docsify