Merge pull request #2454 from filrak/new_release_cycle

New release cycle

Author: filrak

CONTRIBUTING.md

@@ -5,19 +5,17 @@ We've marked some issues as "Easy first pick" to make it easier for newcomers to
 
 Thank you for your interest in, and engagement!
 
-Before you type an issue please check:
-
-Main readme - https://github.com/DivanteLtd/vue-storefront/blob/master/README.md
+Before you type an issue please read about out [release lifecycle](https://docs.vuestorefront.io/guide/basics/project-structure.html)
 
 # Branches
 
-You should fork the project or create branch for new features.
 The main branches used by the core team are:
 
 - master - where we store the stable release of the app (that can be deployed to our demo instances),
 - develop - the most recent version of the app - kind of "nightly" build.
+- RC-x (`x` is current version) - release candidate branch with features that will land in next version.
 
-Please use "develop" for development purposes as the "master" can be merged just as the new release is coming out (about once a month)!
+Please use "develop" or "RC" for development purposes as the "master" can be merged just as the new release is coming out (about once a month)!
 
 ## Issue reporting guidelines:
 
@@ -28,14 +26,11 @@ Always define type of issue:
 While writing issues, be as specific as possible
 All requests regarding support with implementation or application setup should be sent to [email protected]
 
-If the issue is about some changes with particular theme prefix the issue with theme name (ex. "[default] change product tile background color" )
-
-## TypeScript?
+**Tag your issues properly**. If you found a bug tag it with `bug` label. If you're requesting new feature tag it with `feature request`  label.
 
-We're introducing TypeScript to Vue Storefront core, so You can use it where it's aproprierate - but please be pragmatic.
-Here are some thoughts on how to use TS features in Vue Storefront: [TypeScript Action Plan](https://github.com/DivanteLtd/vue-storefront/blob/master/doc/TypeScript%20Action%20Plan.md).
+## Git flow
 
-## Pull request checklist
+## Pull request Checklist
 
 Here’s how to submit a pull request. <b>Pull request that dont meet this requirements will not be merged.</b>
 
@@ -44,15 +39,17 @@ Here’s how to submit a pull request. <b>Pull request that dont meet this requi
 2. Create a branch for your edits. Use the following branch naming conventions:
  * bugfix/task-title
  * feature/task-name
-3. Describe what you've changed. Include screenshots of the new feature or the before and after if your changes include differences in HTML/CSS. Drag and drop the images into the body of your pull request.
+3. Use Pull Request template and fill as much fields as possible to describe your solution.
 4. Reference any relevant issues or supporting documentation in your PR (ex. “Issue: 39. Issue title.”).
 5. If you are adding new feature provide documentation along with the PR. Also add it to [upgrade notes](https://github.com/DivanteLtd/vue-storefront/blob/master/doc/Upgrade%20notes.md)
 6. If you are removing/renaming something or changing it's behavior also include it in [upgrade notes](https://github.com/DivanteLtd/vue-storefront/blob/master/doc/Upgrade%20notes.md)
 7. Test your changes! Run your changes against any existing tests and create new ones when needed. Make sure your changes don’t break the existing project. Make sure that your branch is passing Travis CI build. 
 8. If you have found a potential security vulnerability, please DO NOT report it on the public issue tracker. Instead, send it to us at [email protected]. We will work with you to verify and fix it as soon as possible.
 (https://github.com/DivanteLtd/vue-storefront/blob/master/README.md#documentation--table-of-contents))
 
-## New features
-
-If you are making any new feature make sure it's adjusted to our new, modular approach. Read more [here](https://github.com/DivanteLtd/vue-storefront/blob/master/doc/api-modules/about-modules.md)
+## Acceptance criteria
 
+Your pull request will be merged after meeting following criteria:
+- Everything from "Pull Request Checklist"
+- PR is proposed to appropiate branch 
+- There are at least two approvals from core team members

docs/.vuepress/config.js

@@ -34,6 +34,7 @@ module.exports = {
           title: 'Basics',
           collapsable: false,
           children: [
+            'basics/release-cycle',
             'basics/project-structure',
             'basics/configuration',
             'basics/contributing',

docs/deploy.sh

@@ -4,7 +4,6 @@
 set -e
 
 # build
-npm i
 npm run docs:build
 
 # navigate into the build output directory

docs/guide/basics/release-cycle.md

@@ -0,0 +1,20 @@
+# Release Cycle
+
+This document describes how Vue Storefront code versions are released. You'll learn how the release process looks like, what are the acceptance criteria, what is our git flow and which branch to use as a stable one.
+
+# How Vue Storefront versions are released
+
+From version 1.9 we release each of VSF versions in two phases
+- **Release Candidate phase (RC)** also called "feature version". This version contains all the new features, improvements and additions to the API along with minor bugfixes. New features and additions are merged and released **only** during this phase. The API of features introduced during this phase may slightly change.
+- **Stabilization phase** is the one that ends up with production-ready version. During this phase we do only stabilization and bugfixing for previously introduced features. No new features and API additions are merged. PRs from RC version are tested and their API is simplified and/or adjusted according to feedback. 
+
+So assuming next version is 1.x the two-month cycle will look as following:
+- v1.x-RC.y - unstable version with cutting-edge features ready to test and feedback
+- v1.x.y - stable version of the software **ready for production use**.
+
+# How new features are merged
+
+During RC features Pull Request with new features after feedback and acceptance are normally merged to `develop` branch. 
+After entering the Stabilization Phase we are tagging current develop branch, creating a `RC-x` (where `x` is a number of current version) branch from it and working on stabilization there. 
+During the stabilization phase new features are merged to develop branch and will be merged on next `RC` phase.
+