Contributions are welcome and will be fully credited.
We accept contributions via Pull Requests on GitHub.
If you find a bug, problem, or maybe the documentation just doesn't make sense, please create an Issue to document the concern.
Please be descriptive in your Issue. The more info you provide, the more likely someone will be able to help.
If you're experiencing an issue with the code, the most helpful thing you can do is create an example where you can reproduce the problem. This can be an open source Github repo, a private repo you can share with the maintainers, a CodeSandbox, or really anything to show the issue live with code along side of it.
The project uses PSR-12 Coding Standard. The easiest way to apply the conventions is to install PHP Code Sniffer.
If you're able to fix an active Issue, feel free to create a new Pull Request addressing the problem. There are no gaurantees that the code will be merged in "as is", but chances are, if you're willing to work with the maintainers, everyone will be able to come up with a solution everyone can be happy with.
Make 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.
If you want to do more than one thing, send multiple pull requests.
Please be descriptive in your Pull Request. Whether big or small, it's important to be able to see the context of a change throughout the history of a project.
If the Pull Request is addressing an Issue, please link that issue by specifying the Fixes [Issue #] syntax within the Pull Request.
Your patch won't be accepted if it doesn't have tests.
You can run tests with:
$ composer testMake sure the README.md and any other relevant documentation are kept up-to-date.
We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option.
Create a feature branch. Don't ask us to pull from your main branch.