dunkelfrosch/phpcoverfish

View on GitHub
CONTRIBUTING.md

Summary

Maintainability
Test Coverage
# Contributing to PHPCoverFish

Please note that this project is released with a [Contributor Code of Conduct](CONTRIBUTING_COC.md). By participating in this project you agree to abide by its terms.

* for the project
* make your bug fix or feature addition
* add corresponding tests for your changes(!)
* send a pull request (it's sometimes useful to create topic branch for big feature).

Pull requests for bug fixes must be based on the current stable branch whereas pull requests for new features must be based on `master`.

We are trying to keep backwards compatibility breaks in PHPCoverFish to an absolute minimum. Please take this into account when proposing changes.

Due to time constraints, we are not always able to respond as quickly as we would like. Please do not take delays personal and feel free to remind us if you feel that we forgot to respond.

## Using PHPCoverFish from a Git checkout

The following commands can be used to perform the initial checkout of PHPCoverFish:

    git clone git://github.com/dunkelfrosch/PHPCoverFish.git
    cd PHPCoverFish

Retrieve PHPCoverFish's dependencies using [Composer](http://getcomposer.org/):

    wget http://getcomposer.org/composer.phar
    php composer.phar install

The `PHPCoverFish` script can be used to invoke the PHPCoverFish test runner.

## Reporting issues

Please use the most specific issue tracker to search for existing tickets and to open new tickets:
* [Issue Tracker](https://github.com/dunkelfrosch/PHPCoverFish/issues)