Skip to content

Latest commit

 

History

History
71 lines (42 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

71 lines (42 loc) · 2.24 KB
Raw

Contributing

All contributions are welcome and very much appreciated.

We accept contributions via Pull Requests on Github.

Pull Request guidelines

  • Add tests! - We strongly encourage adding tests as well since the PR might not be accepted without them.

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

  • 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.

Development

Docker 18.03+ and Docker Compose 1.13+ are required for the development environment.

Building the environment

Make sure your Docker images are all built and up-to-date using the following command:

dev/bin/docker-compose build

NOTE: You can target a different version of PHP during development by appending the --build-arg PHP_VERSION=<version> argument.

After that, download all the needed packages required to develop the project:

dev/bin/php composer update --prefer-stable

Debugging

You can run the debugger using the following command:

dev/bin/php-debug vendor/bin/simple-phpunit

Make sure your IDE is setup properly, for more information check out the dedicated documentation.

Code linting

This bundle enforces the PSR-2 and Symfony code standards during development by using the PHP CS Fixer utility. Before committing any code, you can run the utility to fix any potential rule violations:

dev/bin/php php-cs-fixer fix

Running static analysis

You can run static anaysis of code using the following command:

dev/bin/php psalm --shepherd --stats

Testing

You can run the whole test suite using the following command:

dev/bin/php-test vendor/bin/simple-phpunit

Happy coding!