Contributing to Imbo¶
Imbo is an open source project licensed with the MIT license. All contributions should ideally be sent in form of a pull request on GitHub. Please use features branches with descriptive names, and remember to send the pull request against the
If you have found a bug in Imbo, please leave an issue in the issue tracker.
When contributing to Imbo (or any of the other related packages) there are some guidelines you should follow.
Imbo has a coding standard that is partially defined as a PHP Code Sniffer standard. The standard is available on GitHub and is installable via PEAR. There are some details that might not be covered by the standard, so if you send a PR you might notice some nitpicking from my part regarding stuff not covered by the standard. Browse existing code to understand the general look and feel.
When introducing new features you are required to add tests. Unit/integration tests (PHPUnit) and/or Behat scenarios is sufficient. To run the PHPUnit test suite you can execute the following command in the project root directory after installing Imbo:
For the Behat test suite you can the following command:
If you want to run both suites you can simply run:
If you find a bug that you want to fix please add a test first that confirms the bug, and then fix the bug, making the newly added test pass.
API documentation is written using phpDocumentor, and can be generated via a composer script:
End user documentation (the ones you are reading now) is written using Sphinx and is located in the
docs/ directory in the project root. To generate the HTML version of the docs you can execute the following command:
This task also includes a spell checking stage.
Pull requests on GitHub¶
If you want to send a pull request, please do so from a publicly available fork of Imbo, using a feature branch with a self descriptive name. The pull request should be sent to the
develop branch. If your pull request is fixing an open issue from the issue tracker your branch can be named after the issue number, for instance