You found a bug? Don't panic, here are some steps to report it easily:
- Search for it on the bug tracker (don't forget to use the search bar).
- If you find a similar bug, don't hesitate to post a comment to add more importance to the related ticket.
- If you didn't find it, open a new ticket.
If you have to create a new ticket, try to apply the following advices:
- Give an explicit title to the ticket so it will be easier to find it later.
- Be as exhaustive as possible in the description: what did you do? What is the bug? What are the steps to reproduce the bug?
- We also need some information:
- Your library branch (and the commit hash to be more precise)
- Your server configuration: type of hosting, PHP, php-curl, php-mbstring versions
Did you want to fix a bug? To keep a great coordination between collaborators, you will have to follow these indications:
- Be sure the bug is associated to a ticket and say you work on it.
- Fork this project repository.
- Create a new branch. The name of the branch must be explicit and being prefixed by the related ticket id.
- Make your changes to your fork and send a pull request on the master branch.
If you have to write code, please:
- Follow the PSR1/2.
- Test your new classes/methods/lines.
- For a bug, write the test which was absent (if your rollback the patch, this test will fail).
In the workspace folder:
curl -sS https://getcomposer.org/installer | php
php composer.phar install --dev
vendor/bin/phpunit
After the unit tests execution, some reporting are generated :
- Unit test results:
tests/reports/phpunit.xml - Code coverage (XML format, for CI tools):
tests/reports/coverage-clover.xml - Code coverage (HTML format, for humans):
tests/reports/coverage-clover-html/index.html
Copy the file tests/phpunit-credentials.php.dist to tests/phpunit-credentials.php by editing the constants with your test account values.
Launch the specific tests:
vendor/bin/phpunit tests/connection-tests