README

Rumbleship Financial (RFi) php-gateway-client

Setup

Environment Composer + PHP

Package Management and linting. Composer is to PHP as NPM is to Node.composer.json is to PHP as package.json is to Node.

PHP and versioning on a Mac

Personally I'm using php-version for php version management. Command line commands for getting this done:

brew tap homebrew/homebrew-php
brew install php56
brew unlink php56
brew install php-version
source $(brew --prefix php-version)/php-version.sh && php-version 5

To use the php-version command going forward, copy the last line into your .zshrc or .bashrc; Most of this is just duplicating directions into one place for (hopefully) ease of use.

Composer

Composer is to PHP as NPM is to Node.composer.json is to PHP as package.json is to Node.

brew install composer

Now with composer installed you can run composer commands such as:

composer install
composer test
composer lint

Composer is setup to generate an autoload file

composer dump-autoload

Formatting

This project uses php-cs-fixer to standardize and enforce formatting. This process is automated on our CI system but presently needs to be performed manually in local environments: prior to committing, run

$ composer format

Deployment

Branch from dev with release/{VERSION}
Ensure top section in CHANGELOG.md is titled [{VERSION}] -- {DATE} (no stubs above) and has appropriate entries
Draft release in GitHub UI with matching version tag
PR into master with [{VERSION}] -- {DATE} as title and changelog entries as comment
Merge PR, delete branch
Publish release
Merge master into dev, update dev with changelog stubs:

## [Unreleased] -- YYYY-MM-DD

### Added
  * Entry
### Changed
### Deprecated
### Removed
### Fixed
### Security

rumbleship / php-gateway-client

Maintainers

Details