Skip to content

Commit 9909472

Browse files
committed
Fix CONTRIBUTING.md and improve README.md & composer.json
Signed-off-by: William Desportes <[email protected]>
1 parent c2c4527 commit 9909472

File tree

3 files changed

+17
-8
lines changed

3 files changed

+17
-8
lines changed

CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ them and to run automated tests on the code.
2626

2727
We do follow PSR-1 and PSR-2 coding standards.
2828

29-
You can use php-cs-fixer to fix the code to match our expectations:
29+
You can use phpcbf to fix the code to match our expectations:
3030

3131
```
32-
php-cs-fixer fix .
32+
composer run phpcbf
3333
```
3434

3535
## Testsuite
@@ -38,5 +38,5 @@ Our code comes with quite comprehensive testsuite, it is automatically executed
3838
on every commit and pull request, you can also run it locally:
3939

4040
```
41-
./vendor/bin/phpunit -c phpunit.xml.dist
41+
composer run phpunit
4242
```

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -18,22 +18,22 @@ making translations or offering new ideas please contact us.
1818
## Installation
1919

2020
Please use [Composer][1] to install:
21-
22-
```
21+
22+
```
2323
composer require phpmyadmin/shapefile
24-
```
24+
```
2525

2626
To be able to read and write the associated DBF file, you need ``dbase``
2727
extension:
2828

2929
```
3030
pecl install dbase
31-
echo "extension=dbase.so" > /etc/php5/conf.d/dbase.ini
31+
echo "extension=dbase.so" > /etc/php7/conf.d/dbase.ini
3232
```
3333

3434
## Documentation
3535

36-
The API documentation is available at
36+
The API documentation is available at
3737
<https://develdocs.phpmyadmin.net/shapefile/>.
3838

3939
## Usage

composer.json

+9
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,15 @@
1515
"issues": "https://github.com/phpmyadmin/shapefile/issues",
1616
"source": "https://github.com/phpmyadmin/shapefile"
1717
},
18+
"scripts": {
19+
"phpcbf": "phpcbf",
20+
"phpcs": "phpcs",
21+
"phpunit": "phpunit --color=always",
22+
"test": [
23+
"@phpcs",
24+
"@phpunit"
25+
]
26+
},
1827
"require": {
1928
"php": "^7.1"
2029
},

0 commit comments

Comments
 (0)