Use pull request #10874 from ncoden/docs/improve-gitflow-doc for v6.5.0

9b720281b docs: improve gitflow doc in CONTRIBUTING.md
96c1b85ac doc: link CONTRIBUTING.md to README.md

Signed-off-by: Nicolas Coden <nicolas@ncoden.fr>

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f6b6791d2c31ee01c776a412936e3a6cd98b36d1..54e8e41c96ac514c70c4010f9fc5b386d01a5347 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -26,8 +26,8 @@ When you submit a pull request, @mention a few people you’d like to help you r
 
 Foundation uses a git workflow close to [GitFlow](http://nvie.com/posts/a-successful-git-branching-model/). The workflow relies on three branches:
 - **`master`**: The stable branch. It only contains the latest stable version released. Pull requests for docs improvements can be opened on it.
-- **`develop`**: The developing branch is used to prepare the next minor/major version. It always contains all the new features and bug fixes previously made, and constitutes the most up-to-date version of Foundation. Almost every pull request should be opened on this branch. When a new version is released, it is merged on `master`, a support branch is created, and `develop` now targets the next version.
-- **`support/*`**: Support branches are used to support the previous versions (i.e. `support/6.3` for `v6.3.0`) and prepare patches (i.e. `v6.3.1`). When a bug fix is compatible with supported versions, it is also merged on their support branches and patch versions can be released. If a fix is not compatible with `develop`, a pull request can be opened on the latest compatible and supported version.
+- **`develop`**: The developing branch is used to prepare the next minor/major version. It always contains all the new features and bug fixes, and is the most up-to-date version of Foundation. Almost every pull request should be opened on this branch. When a new version is released, it is merged on `master`, a support branch is created, and `develop` now targets the next version.
+- **`support/*`**: Support branches are used to support the previous versions (i.e. `support/v6.4` for `v6.4.0`) and prepare patches (i.e. `v6.4.1`). When a pull request for a bug fix is merged on `develop` and is compatible with supported versions, its commits must be added on the compatible `support/*` branches too. A patch version can be then released. If a fix is not compatible with `develop`, a pull request can be opened on the latest compatible and supported `support/*` branch.
 
 This git workflow was adopted as of `v6.3`, so `v6.2` and previous versions are not supported.
 

diff --git a/README.md b/README.md
index 478d8fdda1a38b725d3ab9774322354fdf17cb65..1edac4c65d0814729bc60087267f1ce3e4cff8da 100644 (file)
--- a/README.md
+++ b/README.md
@@ -53,6 +53,6 @@ Testing Supported By<br/>
 
 ## Contributing
 
-Check out our [contributing guide](http://foundation.zurb.com/develop/contribute.html) to learn how you can contribute to Foundation. You can also browse the [Help Wanted](https://github.com/zurb/foundation-sites/labels/help%20wanted) tag in our issue tracker to find things to do.
+Check out [CONTRIBUTING.md](CONTRIBUTING.md) to see how to report an issue or submit a bug fix or a new feature, and our  [contributing guide](http://foundation.zurb.com/develop/contribute.html) to learn how you can contribute more globally to Foundation. You can also browse the [Help Wanted](https://github.com/zurb/foundation-sites/labels/help%20wanted) tag in our issue tracker to find things to do.
 
 Copyright (c) 2018 ZURB, Inc.