www.aleph1.co.uk Git - yaffs-website/blob - vendor/composer/installers/CONTRIBUTING.md

   1 # Contributing
   2
   3 If you would like to help, please take a look at the list of
   4 [issues](https://github.com/composer/installers/issues).
   5
   6 ## Pull requests
   7
   8 * [Fork and clone](https://help.github.com/articles/fork-a-repo).
   9 * Run the command `php composer.phar install` to install the dependencies.
  10   This will also install the dev dependencies. See [Composer](https://getcomposer.org/doc/03-cli.md#install).
  11 * Use the command `phpunit` to run the tests. See [PHPUnit](http://phpunit.de).
  12 * Create a branch, commit, push and send us a
  13   [pull request](https://help.github.com/articles/using-pull-requests).
  14
  15 To ensure a consistent code base, you should make sure the code follows the
  16 coding standards [PSR-1](http://www.php-fig.org/psr/psr-1/) and
  17 [PSR-2](http://www.php-fig.org/psr/psr-2/).
  18
  19 ### Create a new Installer
  20
  21 * Create class extends `Composer\Installers\BaseInstaller` with your Installer.
  22 * Create unit tests as a separate class or as part of a `Composer\Installers\Test\InstallerTest`.
  23 * Add information about your Installer in `README.md` in section "Current Supported Package Types".
  24 * Run the tests.