Skip to content

Commit 9929166

Browse files
committed
coding standards, scrutinizer-ci for code analysis
1 parent c0598aa commit 9929166

2 files changed

Lines changed: 16 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
The project follows the [Open Knowledge International coding standards](https://github.com/okfn/coding-standards).
44

5+
All PHP Code should conform to [PHP-FIG](http://www.php-fig.org/psr/) accepted PSRs.
6+
57

68
## Getting Started
79

@@ -12,12 +14,25 @@ $ composer install
1214
$ composer test
1315
```
1416

17+
1518
## Phpunit - for unit tests
1619

1720
Phpunit is used for unit tests, you can find the tests under tests directory
1821

1922
Running Phpunit directly: `vendor/bin/phunit`
2023

24+
2125
## Coveralls - for coverage
2226

27+
[![Coveralls](http://img.shields.io/coveralls/frictionlessdata/datapackage-php.svg?branch=master)](https://coveralls.io/r/frictionlessdata/datapackage-php?branch=master)
28+
2329
when running `composer test` phpunit generates coverage report in coverage-clover.xml - this is then sent to Coveralls via Travis.
30+
31+
32+
## Scrutinizer-ci - for code analysis
33+
34+
[Scrutinizer-ci](https://scrutinizer-ci.com/) integrates with GitHub and runs on commits.
35+
36+
It does static code analysis and ensure confirmation to the coding stnadards.
37+
38+
At the moment, the integration with frictionlessdata repo is not working, you can setup a Scrutinizer-ci account for your fork and run against that.

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
[![Travis](https://travis-ci.org/frictionlessdata/datapackage-php.svg?branch=master)](https://travis-ci.org/frictionlessdata/datapackage-php)
44
[![Coveralls](http://img.shields.io/coveralls/frictionlessdata/datapackage-php.svg?branch=master)](https://coveralls.io/r/frictionlessdata/datapackage-php?branch=master)
5+
[![Scrutinizer-ci](https://scrutinizer-ci.com/g/OriHoch/datapackage-php/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/OriHoch/datapackage-php/)
56
[![Packagist](https://img.shields.io/packagist/dm/frictionlessdata/datapackage.svg)](https://packagist.org/packages/frictionlessdata/datapackage)
67
[![SemVer](https://img.shields.io/badge/versions-SemVer-brightgreen.svg)](http://semver.org/)
78
[![Gitter](https://img.shields.io/gitter/room/frictionlessdata/chat.svg)](https://gitter.im/frictionlessdata/chat)

0 commit comments

Comments
 (0)