Skip to content

Commit

Permalink
Merge pull request #208 from Financial-Times/matth/prerelease-ids
Browse files Browse the repository at this point in the history
Add note about prerelease identifiers
  • Loading branch information
i-like-robots authored Oct 24, 2018
2 parents ff25272 + 8e80c20 commit 80cc215
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion release-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Only stable, well tested components and packages may be present in the master or

To develop your component create a new feature branch including your module name, for example if you are building a new tabs component you would create a branch named `feature-x-tabs`. Your component will stay in this branch until it is ready to be merged into the next major or minor release so you are encouraged to merge from or rebase onto the latest development or master branch regularly. You are welcome to raise pull requests against your feature branch if you need to.

Because experimental modules will not be included in any stable releases we allow them to be published separately using a pre-1.0.0 version number. You are free to make as many prereleases as you need. To create a prerelease of your experimental module you must create a tag in the format `module-name-v0.x.x`, for example to release the tabs component you would create tag named `x-tabs-v0.0.1` for the latest commit in the `feature-x-tabs` branch.
Because experimental modules will not be included in any stable releases we allow them to be published separately using a pre-1.0.0 version number. You are free to make as many prereleases as you need. To create a prerelease of your experimental module you must create a tag in the format `module-name-v0.x.x`, for example to release the tabs component you would create tag named `x-tabs-v0.0.1` for the latest commit in the `feature-x-tabs` branch. You may also use an identifier to namespace your prereleases, e.g. `x-tags-v0.0.1-beta.1`.

When your new module is considered stable raise a pull request against the current development branch. Your module will be released as part of the next major or minor version.

Expand Down

0 comments on commit 80cc215

Please sign in to comment.