Skip to content
This repository has been archived by the owner on Apr 30, 2023. It is now read-only.

Latest commit

 

History

History
47 lines (23 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

47 lines (23 loc) · 2.12 KB

Contribution Guide

This project adheres to the following standards and practices.

Versioning

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

Releases will be numbered with the following format:

  • <major>.<minor>.<patch>
  • <breaking>.<feature>.<fix>

And constructed with the following guidelines:

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

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.

Coding Standards

This project follows the FIG PHP Standards Recommendations compliant with the PSR-1: Basic Coding Standard, PSR-2: Coding Style Guide and PSR-4: Autoloader to ensure a high level of interoperability between shared PHP code. If you notice any compliance oversights, please send a patch via pull request.

Feature Requests

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.

Git Flow

This project follows Git-Flow, and as such has master (latest stable releases), develop (latest WIP development) and X.Y support branches (when there's multiple major versions).

Accordingly all pull requests MUST be sent to the develop branch.

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