Skip to content

Latest commit

 

History

History
59 lines (35 loc) · 1.31 KB

CONTRIBUTING.md

File metadata and controls

59 lines (35 loc) · 1.31 KB

Contributing

Contributions are welcome and will be fully credited.

We accept contributions via Pull Requests.

Pull Requests

  • Add tests - Your patch won't be accepted if it doesn't have tests.

  • Consider our release cycle - We try to follow SemVer v2.0.0.

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

Setup

The project setup is based upon docker.

For convenience, common tasks are wrapped up in the Makefile for usage with GNU make.

Installation

Fork and clone the project:

git clone https://github.com/nevadskiy/laravel-position.git

Build docker containers:

docker compose build

Install the composer dependencies:

docker compose run --rm composer install

Running Tests

To run tests, execute the following command:

docker compose run --rm phpunit

Code Style

Formatting is automated through PHP-CS-Fixer

docker compose run --rm php-cs-fixer fix

Happy coding!