@@ -4,62 +4,56 @@ Contributions are **welcome** and will be fully **credited**.
4
4
5
5
We accept contributions via Pull Requests.
6
6
7
-
8
7
## Pull Requests
9
8
10
- - ** Add tests! ** - Your patch won't be accepted if it doesn't have tests.
9
+ - ** Add tests** - Your patch won't be accepted if it doesn't have tests.
11
10
12
- - ** Document any change in behaviour ** - Make sure the ` README.md ` and any other relevant documentation are kept up-to-date .
11
+ - ** Consider our release cycle ** - We try to follow [ SemVer v2.0.0 ] ( http://semver.org/ ) .
13
12
14
- - ** Consider our release cycle ** - We try to follow [ SemVer v2.0.0 ] ( http://semver.org/ ) . Randomly breaking public APIs is not an option .
13
+ - ** Document any change in behaviour ** - Make sure the [ README.md ] ( ../README.md ) and any other relevant documentation are kept up-to-date .
15
14
16
15
- ** One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
17
16
18
- ** Happy coding** !
19
-
20
-
21
17
## Setup
22
18
23
- The project setup is based upon [ Docker ] ( https://docs.docker.com/engine/install ) .
19
+ The project setup is based upon [ docker ] ( https://docs.docker.com/engine/install ) .
24
20
25
- For convenience, common tasks are wrapped up in the [ Makefile] ( Makefile ) for usage with [ GNU make] ( https://www.gnu.org/software/make/ ) .
21
+ For convenience, common tasks are wrapped up in the [ Makefile] ( ../ Makefile) for usage with [ GNU make] ( https://www.gnu.org/software/make/ ) .
26
22
27
- 1 . Fork and clone the project
23
+ ## Installation
28
24
29
- 2 . Run the installation command
25
+ Fork and clone the project:
30
26
27
+ ``` bash
28
+ git clone https://github.com/nevadskiy/laravel-position.git
31
29
```
32
- # Using global composer
33
- composer install
34
30
35
- # Using docker & makefile
36
- make install
31
+ Build docker containers:
32
+
33
+ ``` bash
34
+ docker compose build
37
35
```
38
36
37
+ Install the composer dependencies:
39
38
40
- ## Running Tests
39
+ ``` bash
40
+ docker compose run --rm composer install
41
+ ```
41
42
42
- To execute testsuite, run the following command:
43
+ ## Running Tests
43
44
44
- ``` bash
45
- # Using global composer
46
- composer test
45
+ To run tests, execute the following command:
47
46
48
- # Using docker & makefile
49
- make test
47
+ ``` bash
48
+ docker compose run --rm phpunit
50
49
```
51
50
52
-
53
51
## Code Style
54
52
55
- Formatting is automated through [ PHP-CS-Fixer] ( https://github.com/FriendsOfPHP/PHP-CS-Fixer ) and Github Actions.
56
-
57
- To fix the code style manually, run the following command:
53
+ Formatting is automated through [ PHP-CS-Fixer] ( https://github.com/FriendsOfPHP/PHP-CS-Fixer )
58
54
59
- ``` bash
60
- # Using global composer
61
- composer fix
62
-
63
- # Using docker & makefile
64
- make fix
55
+ ``` bash
56
+ docker compose run --rm php-cs-fixer fix
65
57
```
58
+
59
+ ** Happy coding** !
0 commit comments