From 5b800169e757ad28e8e8a19f64c70b7c761226ad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9goire=20Paris?= Date: Wed, 7 Jan 2015 21:47:00 +0100 Subject: [PATCH] move contributing instructions to a separate file A link to the CONTRIBUTING.md will show up on Github's pull request creation form. Plus, this makes the README shorter and more relevant for users. --- CONTRIBUTING.md | 29 +++++++++++++++++++++++++++++ README.md | 26 -------------------------- 2 files changed, 29 insertions(+), 26 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..820a4002e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +Contributing to Composer +======================== + +Installation from Source +------------------------ + +Prior to contributing to Composer, you must use be able to run the tests. +To achieve this, you must use the sources and not the phar file. + +1. Run `git clone https://github.com/composer/composer.git` +2. Download the [`composer.phar`](https://getcomposer.org/composer.phar) executable +3. Run Composer to get the dependencies: `cd composer && php ../composer.phar install` + +You can now run Composer by executing the `bin/composer` script: `php /path/to/composer/bin/composer` + +Contributing policy +------------------- + +All code contributions - including those of people having commit access - +must go through a pull request and approved by a core developer before being +merged. This is to ensure proper review of all the code. + +Fork the project, create a feature branch, and send us a pull request. + +To ensure a consistent code base, you should make sure the code follows +the [Coding Standards](http://symfony.com/doc/current/contributing/code/standards.html) +which we borrowed from Symfony. + +If you would like to help, take a look at the [list of issues](http://github.com/composer/composer/issues). diff --git a/README.md b/README.md index a86bc83f6..728e11f2e 100644 --- a/README.md +++ b/README.md @@ -32,18 +32,6 @@ themselves. To create libraries/packages please read the 3. Run Composer: `php composer.phar install` 4. Browse for more packages on [Packagist](https://packagist.org). -Installation from Source ------------------------- - -To run tests, or develop Composer itself, you must use the sources and not the phar -file as described above. - -1. Run `git clone https://github.com/composer/composer.git` -2. Download the [`composer.phar`](https://getcomposer.org/composer.phar) executable -3. Run Composer to get the dependencies: `cd composer && php ../composer.phar install` - -You can now run Composer by executing the `bin/composer` script: `php /path/to/composer/bin/composer` - Global installation of Composer (manual) ---------------------------------------- @@ -55,20 +43,6 @@ Updating Composer Running `php composer.phar self-update` or equivalent will update a phar install with the latest version. -Contributing ------------- - -All code contributions - including those of people having commit access - -must go through a pull request and approved by a core developer before being -merged. This is to ensure proper review of all the code. - -Fork the project, create a feature branch, and send us a pull request. - -To ensure a consistent code base, you should make sure the code follows -the [Coding Standards](http://symfony.com/doc/current/contributing/code/standards.html) -which we borrowed from Symfony. - -If you would like to help take a look at the [list of issues](http://github.com/composer/composer/issues). Community ---------