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