You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+10-34Lines changed: 10 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -83,15 +83,6 @@ We use a dockerized environment. Follow these steps to start working with the pr
83
83
make env
84
84
```
85
85
86
-
3.**Install phive and composer dependencies:**
87
-
88
-
```bash
89
-
make phive
90
-
make install
91
-
```
92
-
93
-
<br>
94
-
95
86
## 🔧 Using the Makefile
96
87
97
88
This project uses a Makefile to streamline common development tasks. The Makefile includes utilities for managing Docker environments, installing project dependencies, running tests, and linting code.
@@ -156,7 +147,7 @@ $ make ssh
156
147
$ make down
157
148
```
158
149
159
-
By default, phpunit and phpstan commands will be ran against docker environment.
150
+
By default, phpunit commands will be ran against docker environment.
160
151
161
152
<br>
162
153
@@ -173,7 +164,7 @@ Our project employs [GitHub Actions](https://github.com/features/actions) for co
|[`testing.yml`](workflows/testing.yml)| Runs coverage, mutation and functional tests against SQLite |
178
169
|[`testing-mysql.yml`](workflows/testing.yml)| Runs functional tests against MySQL |
179
170
|[`testing-pgsql.yml`](workflows/testing.yml)| Runs functional tests against PostgreSQL |
@@ -184,7 +175,7 @@ Our project employs [GitHub Actions](https://github.com/features/actions) for co
184
175
## 📝 Before You Contribute
185
176
186
177
***Tests**: Include tests that cover any new features or bug fixes.
187
-
***Code Quality**: Utilize `make lint` for code style checks and `make lint-stan lint-psalm` for static analysis with [PHPStan](https://phpstan.org) and [Psalm](https://psalm.dev/).
178
+
***Code Quality**: Utilize `make lint` for code style checks and `make lint-stan lint-psalm` for static analysis with [Psalm](https://psalm.dev/).
188
179
***Documentation**: Update relevant documentation to reflect your changes, ensuring other developers can understand and use your contributions effectively.
189
180
***Commits**: use Conventional Commits standard to create a commit
190
181
@@ -221,16 +212,6 @@ git commit -am 'fix: something has been fixed'
221
212
222
213
<br>
223
214
224
-
## 📦 PHAR Dependencies
225
-
226
-
We use [Phive](https://phar.io/) to manage PHAR dependencies. You can install all dependencies using the `make phive` command, which will be executed through the Docker environment.
227
-
228
-
```bash
229
-
make phive
230
-
```
231
-
232
-
<br>
233
-
234
215
## 🔍 Coding Standards
235
216
236
217
We enforce coding standards to maintain high code quality and readability. Here's a list of tools we use:
@@ -348,30 +329,25 @@ to run mutation tests.
348
329
349
330
## 🔍 Static Code Analysis
350
331
351
-
We use both [`phpstan/phpstan`](https://github.com/phpstan/phpstan) and [`vimeo/psalm`](https://github.com/vimeo/psalm) to statically analyze the code.
332
+
We use [`vimeo/psalm`](https://github.com/vimeo/psalm) to statically analyze the code.
352
333
353
334
Run
354
335
355
336
```bash
356
-
make lint-stan
357
337
make lint-psalm
358
338
```
359
339
360
340
to run a static code analysis.
361
341
362
-
We also use the baseline features of [`phpstan/phpstan`](https://phpstan.org/user-guide/baseline) and [`vimeo/psalm`](https://psalm.dev/docs/running_psalm/dealing_with_code_issues/#using-a-baseline-file) to ignore existing issues.
342
+
We also use the baseline features of [`vimeo/psalm`](https://psalm.dev/docs/running_psalm/dealing_with_code_issues/#using-a-baseline-file) to ignore existing issues.
0 commit comments