CONTRIBUTING.md 1022 Bytes
Newer Older
1 2 3
Contributing
-------------

LONGMAN's avatar
LONGMAN committed
4
Before you contribute code to php-telegram-bot, please make sure it conforms to the PSR-2 coding standard and that the php-telegram-bot unit tests still pass. The easiest way to contribute is to work on a checkout of the repository, or your own fork. If you do this, you can run the following commands to check if everything is ready to submit:
5 6 7

    cd php-telegram-bot
    composer update
LONGMAN's avatar
LONGMAN committed
8
    vendor/bin/phpcs --report=full --extensions=php -np --standard=build/phpcs .
9 10 11

Which should give you no output, indicating that there are no coding standard errors. And then:

LONGMAN's avatar
LONGMAN committed
12
    vendor/bin/phpunit
13

MBoretto's avatar
MBoretto committed
14 15 16 17 18 19 20
Which should give you no failures or errors. You can ignore any skipped tests as these are for external tools.

Pushing
-------

Development is based on the git flow branching model (see http://nvie.com/posts/a-successful-git-branching-model/ )
If you fix a bug please push in hotfix branch.
LONGMAN's avatar
LONGMAN committed
21
If you develop a new feature please create a new branch.
MBoretto's avatar
MBoretto committed
22 23 24 25

Version
-------
Version number: 0.#version.#hotfix