Skip to content

Latest commit

 

History

History
100 lines (67 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

100 lines (67 loc) · 2.82 KB

Contributing to DBAL fixtures

Code of Conduct

This project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Workflow

  • Fork the project.
  • Make your bug fix or feature addition.
  • Add tests for it. This is important so we don't break it in a future version unintentionally.
  • Send a pull request. Bonus points for topic branches.

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

Coding Guidelines

This project follows the coding standards proposed in PSR-2

You can use PHP CS fixer to (re)format your sourcecode for compliance with this project's coding guidelines:

Run the following command to install the fixer.

$ composer global require friendsofphp/php-cs-fixer

Run the following command if you modified either production or test code. It will fix any coding standard issue automatically.

$ make fix

Make will run the fixer in both folders src and tests.

Using phUML from a Git checkout

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

$ git clone [email protected]:ComPHPPuebla/dbal-fixtures.git

$ cd dbal-fixtures

Retrieve DBAL fixture's dependencies using Composer:

$ composer install

Running DBAL fixture's test suite

Currently the test suite runs against SQLite and MySQL only. Please make sure you have both of them installed.

There's a phpunit.xml.dist file customized for Travis. You'll want to create a phpunit.xml file with your local MySQL username and password.

There is no special configuration for SQLite, it should run out of the box.

Use this command to run the test suite

$ make test

Contributing to the documentation

The documentation of this package is generated by Couscous. You can install Couscous globally with the following commands.

$ curl -OS http://couscous.io/couscous.phar
$ chmod +x couscous.phar
$ sudo mv couscous.phar /usr/local/bin/couscous

Run the following command to preview your changes:

$ couscous preview

Reporting issues

Before opening a new ticket, please search through the existing issues.