CONTRIBUTING.md

CONTRIBUTING

Configure Development Environment

Check out Project and Run Composer

mkdir -p /var/www/textcontrol/txtextcontrol-reportingcloud

cd /var/www/textcontrol/txtextcontrol-reportingcloud

git clone git@github.com:TextControl/txtextcontrol-reportingcloud-php.git .

composer update

composer dump-autoload --optimize

Set up GitHub

Click "Keep my email address private" at https://github.com/settings/emails and use the shown email.

git config user.name  "John Doe"
git config user.email "johndoe@users.noreply.github.com"

Tag and Release Version

git tag release-3.0.x && git push origin --tags

API Documentation (phpdoc)

All the source code in this component library is documented using phpDocumentor.

You can read the API documentation online.

The API documentation is built and published as follows:

bin/build-gh-pages.sh

Unit Tests With Code Coverage (phpunit)

100% unit test coverage is supplied by phpunit.

You can review the code coverage report online, or build it yourself, using the following shell command:

The code coverage report is built and published as follows:

bin/build-gh-pages.sh

Coding Standards

This component library follows PSR-2 coding standards, and additionally:

• Uses lowercase underscore-separated keys names for associative arrays.
• Uses camelCase for namespaces, class, method and property names.

When contributing, please respect this standard with its two above mentioned additions.