Skip to content

Latest commit

 

History

History
71 lines (41 loc) · 2.74 KB

CONTRIBUTING.md

File metadata and controls

71 lines (41 loc) · 2.74 KB
Raw

Contribution Guide

All contributions (in the form of pull requests, issues and proposals) are always welcomed. Please see the contributors page for a list of all contributors.

Please check below the standards and practices that this project adheres to.

Versioning

This package is versioned under the Semantic Versioning guidelines as much as possible.

Releases will be numbered with the following format:

<major>.<minor>.<patch>

And constructed with the following guidelines:

  • Breaking backward compatibility bumps the major and resets the minor and patch.
  • New additions without breaking backward compatibility bumps the minor and resets the patch.
  • Bug fixes and misc changes bumps the patch.

Coding Standards

This package is compliant with the PSR-1, PSR-2 and PSR-4. If you notice any compliance oversights, please send a patch via pull request.

Pull Requests

The pull request process differs for new features and bugs.

Pull requests for bugs may be sent without creating any proposal issue. If you believe that you know of a solution for a bug that has been filed, please leave a comment detailing your proposed fix or create a pull request with the fix mentioning that issue id.

Proposals

If you have a proposal or a feature request, you may create an issue with [Proposal] in the title.

The proposal should also describe the new feature, as well as implementation ideas. The proposal will then be reviewed and either approved or denied. Once a proposal is approved, a pull request may be created implementing the new feature.

Which Branch?

ALL bug fixes should be made to the branch which they belong to. Bug fixes should never be sent to the master branch unless they fix features that exist only in the upcoming release.

If a bug is found on a minor version 1.1 and it exists on the major version 1.0, the bug fix should be sent to the 1.0 branch which will be afterwards merged into the 1.1 branch.

Note: Pull requests which do not follow these guidelines will be closed without any further notice.

Running Tests

You will need an install of Composer before continuing.

First, install the dependencies:

$ composer install

Then run phpunit:

$ vendor/bin/phpunit

If the test suite passes on your local machine you should be good to go.

When you make a pull request, the tests will automatically be run again by Travis CI on multiple php versions.