Skip to main content

๐Ÿ“– Contributing Guide

We welcome contributions to this project. Please read the following guide before posting an issue or sending in pull requests. Please also read our Code of Conduct before contributing or engaging in discussions.

๐Ÿ› Issuesโ€‹

  • Feature requests need to describe as thoroughly as possible and perhaps contain some info on how you would implement it.
  • Bug reports need to be described in detail what the problem is, how it was triggered and perhaps contain a possible solution.
  • Questions are free to be asked about the internals of the codebase and about the project, check out Support for more details.

๐Ÿ”€ Pull Requestsโ€‹

  • Feature requests first need to be discussed and accepted through an issue before sending in a pull request.
  • Bug fixes should contain regression tests.
  • Coding standards should be followed.
  • Add tests Ensure that the current tests pass, and if you've added something new, add the tests where relevant.
  • Document any change in behaviour - Make sure the relevant documentation are up-to-date.
  • Consider our release cycle - We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option.
  • Create feature 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.

๐Ÿ‘จโ€๐Ÿ’ป Coding Standardsโ€‹

  • PSR-12 Coding Standard will automatically be applied by Github Actions.
  • Make sure to typehint and declare return type where applicable.

๐Ÿงช Testingโ€‹

All tests can be run with the following command.

$ composer test

Happy coding ๐ŸŽ‰