Skip to content

Latest commit

 

History

History
55 lines (35 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

55 lines (35 loc) · 2.13 KB
Raw

Contributing

First and foremost, thank you for your interest in contributing to this package 🙏

There some ways to contribute. Some of them don't involve any coding.

Spread the word

This is perhaps the most impactful contribution you can make. Spread the word. Online on your favorite social media channels. Offline to your dear fellow developers who are looking for such a package 📢

Code contributions

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, phpstan 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, phpstan 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 for the docs.

If you notice any typos or grammar issues, feel free to make a pull request with fixes or add missing documentation 📚