Skip to content

Latest commit

 

History

History
82 lines (52 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

82 lines (52 loc) · 1.87 KB
Raw

Contributing

Contributions are welcome and will be fully credited.

We accept contributions via Pull Requests on Github.

Pull Requests

  • PSR-12 Coding Standard - We use Laravel Pint with psr12 preset to apply the conventions.

  • Analyse your code - We use PHPStan with level 8 to perform static analyse.

  • Rector your code - We use Rector to keep the code up-to-date.

  • Add tests - Your patch won't be accepted if it doesn't have tests. We use Pest to write tests.

  • Document any change in behaviour - Make sure the README and any other relevant documentation are kept up-to-date.

  • Consider our release cycle - We try to follow SemVer. Randomly breaking public APIs is not an option.

  • Create topic branches - Don't ask us to pull from your master branch.

  • One pull request per feature - If you want to do more than one thing, send multiple pull requests.

  • Send coherent history - 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.

  • Ensure jobs pass - Please run all jobs (see below) before submitting your pull request, and make sure they pass. We won't accept a patch until all jobs pass.

Jobs

Run all Jobs

composer all

Run Style check

composer style

Run Style fix

composer fix-style

Run Static analyse

composer analyse

Run Tests

composer tests-coverage

Run Rector

composer rector

Run Rector Fix

composer fix-rector

Happy coding!