Rename development branch to 3.x
and add installation instructions
#212
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This changeset suggests renaming the development branch to
3.x
and adds appropriate installation instructions. In particular, this makes it much easier to install the v3 development version or any version like this:$ composer require react/promise:^3@dev $ composer require react/promise:"^3@dev || ^2 || ^1"
This has originally been brought up in #204 by @Seldaek, but instead of defining a branch alias, this PR suggests simply renaming what is currently
master
to3.x
. This is in line with our existing2.x
and1.x
branches and means we do not have to update any alias definitions once we would start working on a potential future4.x
.From a consumer's perspective, this means installation is now much easier, as targeting
^3@dev
(or3.x-dev
) is semantically more obvious and safer than usingdev-master
. Additionally, keep in mind that branch names are development artifacts that are subject to change at some point in the future. Once we would decide to rename or delete any of our version branches, the^3@dev
reference would still be valid as it would also match stable versions if we have any^3
tags at this point (which is safe to assume at this point).Once this PR is merged, I will manually rename the
master
branch to3.x
. At the same time, I also propose to set the current default branch to2.x
until a stable 3.0.0 version has been released. This is more consistent with our website, which also renders the latest tagged release (2.x) instead of the latest development version (3.x). Once a stable 3.0.0 version is released, we should set the default branch to3.x
.Also refs reactphp/async#14 and reactphp/async#11 for similar branch names used in react/async.