Merge pull request composer#338 from composer/contribution

Meta documents

CHANGELOG.md

@@ -0,0 +1,45 @@
+# Change Log
+
+## [Unreleased]
+
+## v1.2.0 - 2016-08-13
+### Added
+* Installer for Attogram.
+* Installer for Cockpit.
+* Installer for Plentymarkets.
+* Installer for ReIndex.
+* Installer for Vanilla.
+* Installer for YAWIK.
+* Added missing environments for new Shopware (5.2) Plugin System.
+
+## v1.1.0 - 2016-07-05
+### Added
+* Installer for ReIndex.
+* Installer for RadPHP.
+* Installer for Decibel.
+* Installer for Phifty.
+* Installer for ExpressionEngine.
+
+### Changed
+* New paths for new Bitrix CMS. Old paths is deprecated.
+
+### Deprecated
+* Old paths in Bitrix CMS Installer is deprecated.
+
+## v1.0.25 - 2016-04-13
+### Removed
+* Revert TYPO3 installer deletion.
+
+## v1.0.24 - 2016-04-05
+### Added
+* Installer for ImageCMS.
+* Installer for Mautic.
+* New types in the Kirby installer: `kirby-plugin` and `kirby-field`.
+* New types in the Drupal installer: `custom-theme` and `custom-module`.
+
+### Changed
+* Switch to PSR-4.
+* Update Bitrix Installer: configuration for setting custom path to directory with kernel.
+
+### Removed
+* Remove TYPO3 Extension installers.

CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# Contributing
+
+If you would like to help, please take a look at the list of
+[issues](https://github.com/composer/installers/issues).
+
+## Pull requests
+
+* [Fork and clone](https://help.github.com/articles/fork-a-repo).
+* Run the command `php composer.phar install` to install the dependencies.
+  This will also install the dev dependencies. See [Composer](https://getcomposer.org/doc/03-cli.md#install).
+* Use the command `phpunit` to run the tests. See [PHPUnit](http://phpunit.de).
+* Add information about your changes into `CHANGELOG.md` in section "[Unreleased]". 
+  The format this file is based on [Keep a Changelog](http://keepachangelog.com/) 
+  and this project adheres to [Semantic Versioning](http://semver.org/).
+* Create a branch, commit, push and send us a
+  [pull request](https://help.github.com/articles/using-pull-requests).
+
+To ensure a consistent code base, you should make sure the code follows the
+coding standards [PSR-1](http://www.php-fig.org/psr/psr-1/) and 
+[PSR-2](http://www.php-fig.org/psr/psr-2/).
+
+### Create a new Installer
+
+* Create class extends `Composer\Installers\BaseInstaller` with your Installer.
+* Create unit tests as a separate class or as part of a `Composer\Installers\Test\InstallerTest`.
+* Add information about your Installer in `README.md` in section "Current Supported Package Types".
+* Run the tests.

README.md

@@ -6,11 +6,11 @@ This is for PHP package authors to require in their `composer.json`. It will
 install their package to the correct location based on the specified package
 type.
 
-The goal of `installers` is to be a simple package type to install path map.
+The goal of Installers is to be a simple package type to install path map.
 Users can also customize the install path per package and package authors can
 modify the package name upon installing.
 
-`installers` isn't intended on replacing all custom installers. If your
+Installers isn't intended on replacing all custom installers. If your
 package requires special installation handling then by all means, create a
 custom installer to handle it.
 
@@ -25,7 +25,7 @@ is not needed to install packages with these frameworks:
 * Yii
 * Yii2
 
-**Current Supported Package Types**:
+## Current Supported Package Types
 
 > Stable types are marked as **bold**, this means that installation paths
 > for those type will not be changed. Any adjustment for those types would
@@ -193,30 +193,15 @@ will allow this:
 Please note the name entered into `installer-name` will be the final and will
 not be inflected.
 
-## Contribute!
+## Should we allow dynamic package types or paths? No.
 
-* [Fork and clone](https://help.github.com/articles/fork-a-repo).
-* Run the command `php composer.phar install` to install the dependencies.
-  This will also install the dev dependencies. See [Composer](https://getcomposer.org/doc/03-cli.md#install).
-* Use the command `phpunit` to run the tests. See [PHPUnit](http://phpunit.de).
-* Create a branch, commit, push and send us a
-  [pull request](https://help.github.com/articles/using-pull-requests).
-
-To ensure a consistent code base, you should make sure the code follows the
-[Coding Standards](http://symfony.com/doc/2.0/contributing/code/standards.html)
-which we borrowed from Symfony.
-
-If you would like to help, please take a look at the list of
-[issues](https://github.com/composer/installers/issues).
-
-### Should we allow dynamic package types or paths? No.
 What are they? The ability for a package author to determine where a package
 will be installed either through setting the path directly in their
 `composer.json` or through a dynamic package type: `"type":
 "framework-install-here"`.
 
 It has been proposed many times. Even implemented once early on and then
-removed. `installers` won't do this because it would allow a single package
+removed. Installers won't do this because it would allow a single package
 author to wipe out entire folders without the user's consent. That user would
 then come here to yell at us.