Skip to content

Files

Latest commit

c5d6294 · Jun 23, 2017

History

History
36 lines (19 loc) · 1.53 KB

CONTRIBUTING.textile

File metadata and controls

36 lines (19 loc) · 1.53 KB

Contributing

Please take a quick look at this document before to make contribution process easier for all parties involved.

License

GNU General Public License, version 2. By contributing code, you agree to license your additions under the GPLv2 license.

Configure git

For convenience your committer, git user, should be linked to your GitHub account:

$ git config --global user.name "John Doe"
$ git config --global user.email john.doe@example.com

Make sure to use an email address that is linked to your GitHub account. It can be a throwaway address or you can use GitHub’s email protection features. We don’t want your emails, but this is to make sure we know who did what. All commits nicely link to their author, instead of them coming from foobar@invalid.tld.

Dependencies

Dependencies are managed using Composer. After you have cloned the repository, run composer install:

$ composer install

And update before testing and committing:

$ composer update

Coding standard

The project follows the PSR-0 and PSR-2 standards with PHP 5.2 style namespacing. You can use PHP_CodeSniffer to make sure your additions follow them too:

$ ./vendor/bin/phpcs --standard=phpcs.xml src

Versioning

Semantic Versioning and major.minor.path format.