From 96acd5068129b9098768ee5ab8431fcfa34db9d7 Mon Sep 17 00:00:00 2001 From: Ingo Schommer Date: Thu, 22 Nov 2012 15:10:10 +0100 Subject: [PATCH] Update composer contributing instructions --- docs/en/installation/composer.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/en/installation/composer.md b/docs/en/installation/composer.md index 898acd4e6..1a472caba 100644 --- a/docs/en/installation/composer.md +++ b/docs/en/installation/composer.md @@ -183,11 +183,14 @@ This is not the only way to set things up in Composer. For more information on t ## Setting up an environment for contributing to SilverStripe -So you want to contribute to SilverStripe? Fantastic! There are a couple modules that will help you, that aren't installed by default: +So you want to contribute to SilverStripe? Fantastic! You have to initialize your project from the latest development branch, +rather than a release tag. The process will take a bit longer, since all modules are checked out as full git repositories which you can work on. + + composer create-project silverstripe/installer --dev ./my/website/folder 3.0.x-dev + +The `--dev` flag will add a couple modules which are useful for SilverStripe development: * The `compass` module will regenerate CSS if you update the SCSS files * The `docsviewer` module will let you preview changes to the project documentation -By default, these modules aren't installed, but you can install them with a special version of composer's update command: - - composer update --dev +Note that you can also include those into an existing project by running `composer update --dev`. \ No newline at end of file