From 7b635f835decab262e089b60c9d09621f5960345 Mon Sep 17 00:00:00 2001 From: Raphael Antonmattei Date: Wed, 25 Feb 2015 11:46:36 -0500 Subject: [PATCH] VCS section: add requirements for the branch name If you want to use a custom branch in your requirements in your `composer.json`, that branch must be prefixed with "dev-" or you'll get an error: ```sh [UnexpectedValueException] Could not parse version constraint some-branch: Invalid version string "some-branch". ``` It took me a while to find that info, so I figured I'd rather edit the doc. Let me know. --- doc/05-repositories.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/05-repositories.md b/doc/05-repositories.md index 2dd5e24d5..3b0bd4d38 100644 --- a/doc/05-repositories.md +++ b/doc/05-repositories.md @@ -234,7 +234,7 @@ project to use the patched version. If the library is on GitHub (this is the case most of the time), you can simply fork it there and push your changes to your fork. After that you update the project's `composer.json`. All you have to do is add your fork as a repository and update the version constraint to -point to your custom branch. For version constraint naming conventions see +point to your custom branch. Your custom branch name must be prefixed with `"dev-"`. For version constraint naming conventions see [Libraries](02-libraries.md) for more information. Example assuming you patched monolog to fix a bug in the `bugfix` branch: