|
| 1 | +# Contribution Guide |
| 2 | + |
| 3 | +This project adheres to the following standards and practices. |
| 4 | + |
| 5 | +## Versioning |
| 6 | + |
| 7 | +This package is versioned under the [Semantic Versioning](http://semver.org/) guidelines as much as possible. |
| 8 | + |
| 9 | +Releases will be numbered with the following format: |
| 10 | + |
| 11 | +`<major>.<minor>.<patch>` |
| 12 | + |
| 13 | +And constructed with the following guidelines: |
| 14 | + |
| 15 | +* Breaking backward compatibility bumps the major and resets the minor and patch. |
| 16 | +* New additions without breaking backward compatibility bumps the minor and resets the patch. |
| 17 | +* Bug fixes and misc changes bumps the patch. |
| 18 | + |
| 19 | +## Coding Standards |
| 20 | + |
| 21 | +This package is compliant with the |
| 22 | +[PSR-1](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md), |
| 23 | +[PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) and |
| 24 | +[PSR-4](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md). |
| 25 | +If you notice any compliance oversights, please send a patch via pull request. |
| 26 | + |
| 27 | +## Pull Requests |
| 28 | + |
| 29 | +The pull request process differs for new features and bugs. |
| 30 | + |
| 31 | +Pull requests for bugs may be sent without creating any proposal issue. |
| 32 | +If you believe that you know of a solution for a bug that has been filed, |
| 33 | +please leave a comment detailing your proposed fix or create a pull request with the fix mentioning that issue id. |
| 34 | + |
| 35 | +### Proposal \ Feature Requests |
| 36 | + |
| 37 | +If you have a proposal or a feature request, you may create an issue with `[Proposal]` in the title. |
| 38 | + |
| 39 | +The proposal should also describe the new feature, as well as implementation ideas. |
| 40 | +The proposal will then be reviewed and either approved or denied. Once a proposal is approved, |
| 41 | +a pull request may be created implementing the new feature. |
| 42 | + |
| 43 | +### Which Branch? |
| 44 | + |
| 45 | +**ALL** bug fixes should be made to the branch which they belong to. |
| 46 | +Bug fixes should never be sent to the `master` branch unless they fix features that exist only in the upcoming release. |
| 47 | + |
| 48 | +If a bug is found on a `minor` version `1.1` and it exists on the `major` version `1.0`, |
| 49 | +the bug fix should be sent to the `1.0` branch which will be afterwards merged into the `1.1` branch. |
0 commit comments