Contribution

Yo-An Lin edited this page Jun 25, 2014 · 15 revisions

Before You Start Your Work

Please discuss your idea first on GitHub issues with us before sending your pull request for new features and design.

To develop new features, please checkout develop branch for development.

For bug fix, you may fix it directly on master.

Development Policy

  • Don't add too many dependencies just for few features.
  • You should keep the compiled phar file (phpbrew.phar) as small as possible.
  • You should add an unit test for the newly added feature.
  • PRs should pass the travis-ci tests, your PR can get merged sooner if your PR passed these tests.
  • Please follow the current coding style in PHPBrew.
  • Don't replace under-layer components just for replacing components. The replacement MUST be for new obvious features.

Pull Request Proposal

Please describe the details of your PR. For new features, please consult the PR template below:

## Purpose

Describe the purpose of this PR.

## Changes

Describe the changes of this PR.

## Effect

Is there any effect if we merge this PR.

## Tests

The unit tests of this PR.

## Usage

How to enable/use this feature

Setup Your Development Environment

Installing the dependencies

$ composer install --dev

Changing Shell Script

The main shell script is in phpbrew.sh, you may modify it then re-source it in your shell:

source phpbrew.sh

If everything works fine, you may update it to the InitCommand class:

scripts/update-init-script

Changing PHP Code

If you need to modify PHP source, you may run bin/phpbrew to test your code:

php bin/phpbrew {command}

If everything works fine, you may re-compile the phpbrew phar file:

scripts/compile

The compilation needs onion to do the job, please download onion from http://github.com/c9s/Onion

PHP Release channels

Build Status

master: Build Status

develop: Build Status

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.