danog/docker-php-extension-installer
1
0
Fork 0
mirror of https://github.com/danog/docker-php-extension-installer.git synced 2024-11-26 20:15:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add a hint about coding style errors

Browse Source
This commit is contained in:
Michele Locati 2021-08-11 10:29:15 +02:00
parent 788276d833
commit 132dbb5a49
No known key found for this signature in database
GPG Key ID: 98B7CE2E7234E28B
1 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -314,7 +314,27 @@ Feel free to subscribe to it to receive failure notifications.
### Formatting code
Before submitting any pull request, be sure to execute the `lint` script in the `scripts` directory (or `lint.bat` on Windows).
Before submitting any pull request, you should execute the `lint` script in the `scripts` directory (or `lint.bat` on Windows).
If you don't do that, and if there's a coding style error, you'll see that the `Check shell coding style` and/or the `Check PHP coding style` GitHub Actions will fail.
The error will be something like this:
```diff
--- filename.orig
+++ filename
@@ -line number,7 +line number,7 @@
good line of code #1
good line of code #2
good line of code #3
- the original line with a wrong coding style
+ the line wrong coding style that has been corrected
good line of code #4
good line of code #5
good line of code #6
```
So, you should fix highlighed line (the one(s) at `line number`) by replacing what you see after the `-` with what you see after the `+`
### Adding support to a new PHP extension?