Skip to content

Latest commit

 

History

History
52 lines (28 loc) · 2.57 KB

CONTRIBUTING.textile

File metadata and controls

52 lines (28 loc) · 2.57 KB
Raw

Contributing

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

License

BSD 3-Clause. By contributing code, you agree to license your additions under the BSD 3-Clause 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 [email protected]

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 [email protected].

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. You can use PHP_CodeSniffer to make sure your additions follow them too:

$ ./vendor/bin/phpcs --standard=PSR1,PSR2 src test

Versioning

Semantic Versioning and major.minor.path format:

  • Only major versions can make incompatible API changes.
  • Minor versions can add backwards-compatible features and changes.
  • Patch versions should only contain fixes.

Keep backwards compatibility in mind when you do changes to the Textile language, its processing or to the application interface.

Testing and code coverage

The project uses PHPunit for running its unit tests. As much of the codebase should be covered with tests as possible. When adding new features, also add tests for them. If you find a bug, create a test that can replicate the said bug and, if possible, fix it so that the tests pass. To run tests, simply run:

$ ./vendor/bin/phpunit

Running tests requires PHP 5.4.0 and PCRE with PCRE_UTF8 support. Generating optional code coverage reports requires Xdebug.

Tests should pass before the changes can be merged to the codebase. If you create a pull requests that does not pass tests, CI will complain in the pull request thread. To get your changes merged, you should rework the code or tests until everything works smoothly.