-<!-- For replicatable bugs or feature requests GitHub is the right place. The [Foundation Forum](http://foundation.zurb.com/forum) would be a great place to seek some help with general questions or help with your code. There you can reach out to the community to share your insights or ask questions. -->
-
-#### How to reproduce this bug:
-
-1. Step one
-2. Step two
-3. Step three
-
-#### What should happen:
-
-#### What happened instead:
-
-#### Browser(s) and Device(s) tested on:
-
-#### Foundation Version(s) you are using:
-
-#### Test case link:
-
-<!-- Give us a link to a CodePen or JSFiddle that recreates the issue. -->
-
-- [CodePen with Foundation 6.3.1, Float Grid and MotionUI](http://codepen.io/IamManchanda/pen/LWGZxR)
-- [CodePen with Foundation 6.3.1, Float Grid with RTL Direction and MotionUI](http://codepen.io/IamManchanda/pen/bRYOMv)
-- [CodePen with Foundation 6.3.1, Flexbox grid and MotionUI](http://codepen.io/IamManchanda/pen/zZrBEv)
-
-- [CodePen with Foundation 6.4.1, XY Flexbox grid and MotionUI](http://codepen.io/IamManchanda/pen/EXbGKJ)
-- [CodePen with Foundation 6.4.1, XY Flexbox grid with RTL Direction and MotionUI](http://codepen.io/IamManchanda/pen/qjVLoO)
-- [CodePen with Foundation 6.4.1, XY Flexbox grid with Prototype Mode and MotionUI](http://codepen.io/IamManchanda/pen/XgzopG)
-- [CodePen with Foundation 6.4.1, Float Grid and MotionUI](http://codepen.io/IamManchanda/pen/qjVLrB)
+<!--- --------------------------------------------------------------------- -->
+<!--- Please fill the following template -->
+<!--- Your issue may be ignored otherwise -->
+<!--- --------------------------------------------------------------------- -->
+<!--- Only submit bug or feature requests here. For help or questions to -->
+<!--- the community, see the forum: https://foundation.zurb.com/forum -->
+
+## Expected Behavior
+<!--- If describing a bug, tell us what should happen. -->
+<!--- If suggesting a change/feature, tell us why and how it should work. -->
+
+## Current Behavior
+<!--- If describing a bug, tell us what happens instead. -->
+<!--- If suggesting a change/feature, explain the difference from -->
+<!--- current behavior. -->
+
+## Possible Solution
+<!--- Not obligatory, but suggest a fix/reason for the bug, -->
+<!--- or ideas how to implement the addition or change. -->
+
+## Test Case and/or Steps to Reproduce (for bugs)
+<!--- We highly recommend you to provide a live example of your bug so we -->
+<!--- can reproduce it. You can create a test case with the last Foundation -->
+<!--- version by forking https://codepen.io/ncoden/pen/YLzjeq -->
+Test Case: <!-- https://... -->
+
+<!--- If you cannot provide a test case, provide an unambiguous set of -->
+<!--- steps to reproduce, with your code and configuration. -->
+How to reproduce:
+1.
+2.
+3.
+
+## Context
+<!--- How has this issue affected you? What are you trying to accomplish? -->
+<!--- Providing context helps us come up with a solution that is most -->
+<!--- useful in the real world -->
+
+## Your Environment
+<!--- Include as many relevant details about the context and environment -->
+<!--- you experienced the bug in. You can also provide logs. -->
+- Foundation version(s) used:
+- Browser(s) name and version(s):
+- Operating System and version (desktop or mobile):
+- Link to your project:
+
+## Checklist (all required):
+<!--- Go over all the following points, and put an `x` in the boxes. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. -->
+- [ ] I have read and follow the [CONTRIBUTING](CONTRIBUTING.md) document.
+- [ ] This is a bug report or a feature request.
+- [ ] There are no other issues similar to this one.
+- [ ] The issue title is descriptive.
+- [ ] The template is fully and correctly filled.
+
+<!--- --------------------------------------------------------------------- -->
+<!--- For more information, see the CONTRIBUTING.md document -->
+<!--- Thank you for your issue and happy coding ;) -->
+<!--- --------------------------------------------------------------------- -->
-Before submitting a pull request, make sure it's targeting the right branch:
+<!--- --------------------------------------------------------------------- -->
+<!--- Please fill the following template -->
+<!--- Your pull request may be ignored otherwise -->
+<!--- --------------------------------------------------------------------- -->
-- For the latest version, use `develop`.
-- For bug fixes incompatible with `develop`, use the support branch of the latest compatible and supported version `support/6.x`.
+## Description
+<!--- Describe your changes in detail. Include any relevant information -->
+<!--- (reasons, difficulties, links to web references, related issues...) -->
-If you're fixing a JavaScript issue, it would help to create a new test case under the folder `test/visual/` that recreates the issue and show's that it's been fixed. Run `npm test` to compile the testing folder.
-Happy coding! :)
+
+<!--- Bugs and new features/improvements must be presented and discussed in -->
+<!--- an issue first. Please create one if there is no issue related to -->
+<!--- this pull request. -->
+- Closes <!--- link to issue... -->
+
+## Motivation and Context
+<!--- Why is this change required? What problem does it solve? -->
+
+## Screenshots (if appropriate):
+
+## Types of changes
+<!--- What types of changes does your code introduce? -->
+<!--- Put an `x` in all the boxes that apply: -->
+- [ ] Documentation
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing
+ functionality to change)
+
+## Checklist (all required):
+<!--- Go over all the following points, and put an `x` in the boxes. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. -->
+- [ ] I have read and follow the [CONTRIBUTING](CONTRIBUTING.md) document.
+- [ ] There are no other pull request similar to this one.
+- [ ] The pull request title is descriptive.
+- [ ] The template is fully and correctly filled.
+- [ ] The pull request targets the right branch (`develop` or `support/*`).
+- [ ] My commits are correctly titled and contain all relevant information.
+- [ ] My code follows the code style of this project.
+- [ ] I have updated the documentation accordingly to my changes (if relevant).
+- [ ] I have added tests to cover my changes (if relevant).
+- [ ] All new and existing tests passed.
+
+<!--- --------------------------------------------------------------------- -->
+<!--- For more information, see the CONTRIBUTING.md document -->
+<!--- Thank you for your pull request and happy coding ;) -->
+<!--- --------------------------------------------------------------------- -->
# Foundation Contributing Guidelines
-Although Foundation is maintained by ZURB, it’s also a community effort. Whether it’s bug fixing, feature development, or contributions to the ecosystem, designers and developers from all over the world help make Foundation the most advanced framework in the world.
-
-A select group of our contributors have been dubbed *Yetinauts*. They have direct write access to the codebase and support the core Foundation team on the development of the framework. Are you interested in making your mark on the Foundation framework? Whether you’re just submitting bugs or helping us write new features, there are many ways to contribute to Foundation.
-
-## Terms
-
-- The **community** is anyone commenting on issues or opening pull requests. That includes you!
-- A **Yetinaut** is anyone with write access to the repository.
-- The **Core Team** is anyone on the Foundation Team.
+Although Foundation was built and maintained by ZURB for years, it is today a community project. Whether it’s bug fixing, feature development, or contributions to the ecosystem, designers and developers from all over the world help make Foundation the most advanced framework in the world.
## Issues
-Open an issue for any problem you have with the framework. If there's anything missing from your issue, such as extra context, a code sample, etc. a team member will ask for more info in the comments.
-
-Support requests are generally better suited for the [Foundation Forum](http://foundation.zurb.com/forum), while GitHub is more appropriate for bugs. If you aren’t sure if your issue is a bug or not, don’t worry! Post your problem on GitHub and the team will help you along. Every participant is expected to follow the project's [Code of Conduct](code-of-conduct.md) so please be courteous and respectful.
+For **bugs**, **feature requests**, **incorrect documentation** or any problem you have with Foundation, you can open a new issue. If you need help to use Foundation, the [Foundation Forum](https://foundation.zurb.com/forum) would be more appropriate. If you aren't sure if your issue is a bug or not, don’t worry! Post your problem on GitHub and the team will help you along.
+
+Every participant is expected to follow the project's [Code of Conduct](code-of-conduct.md) so please be courteous and respectful.
+
+### Report a bug
+
+1. **Search for similar opened or closed issues** ([link](https://github.com/zurb/foundation-sites/issues?utf8=%E2%9C%93&q=is%3Aissue)).
+ It is likely that someone else got the same problem as you before and already reported it.
+2. **Make sure of the following:**
+ * [ ] There are no [opened or closed issues](https://github.com/zurb/foundation-sites/issues?utf8=%E2%9C%93&q=is%3Aissue) similar to this bug
+ * [ ] This is a bug and not a missing feature
+ * [ ] This bug comes from Foundation and not the browser or an other library
+ * [ ] This bug is still present in the latest Foundation release
+3. **Prepare a test case with your bug** ([link](https://codepen.io/ncoden/pen/YLzjeq)).
+ Trying to reproduce a bug is often time-consuming. Please isolate your bug in a dedicated test case. The simpler is the test case, the best it is.
+4. **Create your issue** ([link](https://github.com/zurb/foundation-sites/issues/new)).
+ Please provide a complete description of your bug: What do you expect? What happends instead? Which version of Foundation do you use, which ones are affected by the bug? Keep in mind that someone will spend a lot of time to understand your issue, make the task easy for him/her.
+
+### Request for a new feature
+1. **Search for similar opened or closed issues** ([link](https://github.com/zurb/foundation-sites/issues?utf8=%E2%9C%93&q=is%3Aissue)).
+ It is likely that someone else needed a similar feature as yours and already requested it.
+2. **Make sure of the following:**
+ * [ ] There are no [opened or closed issues](https://github.com/zurb/foundation-sites/issues?utf8=%E2%9C%93&q=is%3Aissue) similar to your request
+ * [ ] This is a missing feature and not a bug
+3. **Prepare a clear use case for the requested feature**.
+ This will help you to make sure that this is the feature you want, and us to better understand your needs and how it would benefit to everyone the best way.
+4. **Create your issue** ([link](https://github.com/zurb/foundation-sites/issues/new)).
+ Please provide a complete description of the feature you want, the use case you prepared will help you for that. After you created your issue, if you feel ready, you can start working on a pull request (please tell us so). See [Contributions](#contributions) below.
## Contributions
-All new features and bug fixes should be submitted as pull requests, so the community can review and discuss them. Core Team members can commit directly to the repository for very small changes, but should generally also submit new code as a pull request.
+All new features and bug fixes should be submitted as pull requests, so the community can review and discuss them. The rule is the same for everyone, for new contributors as for Core Team members.
+
+Before working on a bug fix or a new feature, please make sure of the following:
+* [ ] **There is no similar pull request that was rejected or is not merged yet** ([link](https://github.com/zurb/foundation-sites/issues?utf8=%E2%9C%93&q=is%3Apr)).
+ Add a comment on this pull request otherwise. Explain us why this pull request is urgent or important to you.
+* [ ] **There is an open issue related to this bug or feature**.
+ Please create one otherwise. It is often useful to talk about the bug fix or feature and the best way to implement it before working on it. You can skip this step for obvious changes (like typo in the documentation).
+
+After you made these checks, please follow these advices to create your pull requests:
+1. **Work on a dedicated Git branch**.
+ So you default `develop` branch stay clean and you can open multiple Pull Requests at the same time for various issues. See (2) below for the branch name format.
+2. **Use our standard format for branch, commit and pull request names**.
+ It must reference the related issue, be written in the "imperative" form (like if it was completing `now the software should...`) and be prefixed by a type (`feat` for new feature, `fix` if you repair something, `docs` for documentation, `refactor` for non-breaking code cleaning, `style` for code formatting, `tests` for unit or visual tests or `chore` for boring day-to-day tasks not affecting the actual code. See the [AngularJs Git Commit Message Convention](https://gist.github.com/stephenparish/9941e89d80e2bc58a153)). For example: `docs: improve Dropdown usage example #123` for commit/pull request names and `docs/dropdown-improve-usage-example-123` for the branch name.
+3. **Describe everything you did and why in your commit and pull request body**.
+ Even if you already mentionned it in the related issue, please explain what you did and for which reasons. Give references to related issues, comments, test cases or any useful resources.
+4. **Provide a clear and readable code**.
+ Make sure that the code you changed is consistent across components and that anyone can easily understand its behavior. Split it in abstract functions, avoid code duplication and add comments when needed. You can open a "work-in-progress" pull request (prefix it with "[WIP]") if you need any help with that.
+5. **Make sure that everything works and tests pass**.
+ You must absolutely check that everything still works after your changes. Please also add tests for features you added or uncovered bugs you fixed. See the [Testing](https://github.com/zurb/foundation-sites#testing) section.
+6. **Create your pull request** ([link](https://github.com/zurb/foundation-sites/compare)).
+ Make sure it targets the right branch: most often `develop`, unless you provide a fix for an older version and it should be `support/*`. Take a look at our [Git Workflow](#git-workflow) below.
When you submit a pull request, @mention a few people you’d like to help you review it. Once those people have signed off on it, the pull request can be merged! Core Team members will handle the merge itself.
## Git Workflow
-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. Do NOT open pull requests 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, and is the most up-to-date version of Foundation. Almost every pull request should be opened on this branch (fixes, features, documentation...). 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.
+Foundation uses a Git workflow close to the the successful [GitFlow](http://nvie.com/posts/a-successful-git-branching-model/) branching model, to which we added "support" branches to be able to release patches for older Foundation versions. Most of the time you will not have to care about this workflow and can simply open your pull request on `develop`.
+
+The workflow relies on three branches:
+
+- **`master`**
+
+ The stable branch. It only contains the latest stable version released. **Do NOT open pull requests on it**.
+
+- **`develop`**
+
+ 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 (fixes, features, documentation...). When a new version is released, it is merged on `master`, a support branch is created, and `develop` now targets the next version.
+
+- **`support/<version>`**
+
+ Used to support the previous versions (i.e. `support/v6.5` for `v6.5.0`) and prepare patches (i.e. `v6.5.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 fully adopted as of `v6.5`, so `v6.4` and previous versions are not supported.
If you aren't sure how a feature should be implemented, we recommend checking out our [standards document](https://github.com/zurb/foundation-standards), which outlines every aspect of writing framework features, from Sass to JavaScript.
-## Becoming a Yetinaut
+## Core Team
-Want to join our crack team of Yetinauts? The Core Team is inviting active community members to become Yetinauts on a case-by-case basis. If you want to become a contributor, engage the community on the Foundation Forum, help us close issues on GitHub, and review pull requests from other contributors.
+Want to help us making Foundation the best framework ever? The Core Team is inviting active community members to join it. If you want to become a contributor, engage the community on the Foundation Forum, help us close issues on GitHub, and review pull requests from other contributors.
If you’ve made substantial contributions to a Foundation framework and haven’t heard from us yet, you can reach out at foundation@zurb.com.
-# [Foundation for Sites](http://foundation.zurb.com)
+<p align="center">
+ <a href="http://foundation.zurb.com/">
+ <img src="https://user-images.githubusercontent.com/9939075/38782856-2a64a43e-40fa-11e8-89cd-e873af03b3c4.png" alt="Foundation for Sites 6" width="448px" style="max-width:100%;"/>
+ </a>
+</p>
+
+
+
+
+<p align="center">
+ <a href="https://foundation.zurb.com/sites/docs/installation.html"><b>Install</b></a>
+ | <a href="https://foundation.zurb.com/sites/docs">Documentation</a>
+ | <a href="https://github.com/zurb/foundation-sites/releases">Releases</a>
+ | <a href="CONTRIBUTING.md">Contributing</a>
+</p>
+
+---
+
[](https://travis-ci.org/zurb/foundation-sites)
+[](https://david-dm.org/zurb/foundation-sites)
+[](https://david-dm.org/zurb/foundation-sites?type=dev)
[](https://badge.fury.io/js/foundation-sites)
[](https://badge.fury.io/bo/foundation-sites)
[](https://badge.fury.io/rb/foundation-rails)
[](https://www.jsdelivr.com/package/npm/foundation-sites)
-[](https://david-dm.org/zurb/foundation-sites)
-[](https://david-dm.org/zurb/foundation-sites?type=dev)
[](https://gitter.im/zurb/foundation-sites?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
Foundation is the most advanced responsive front-end framework in the world. Quickly go from prototype to production, building sites or apps that work on any kind of device with Foundation. Includes a fully customizable, responsive grid, a large library of Sass mixins, commonly used JavaScript plugins, and full accessibility support.
-## Getting Started
-
-The quickest way to get started is with the [basic CSS download](http://foundation.zurb.com/sites/download/). You can get versions with every component, essential ones only, or a custom build.
-
-If you're a Sass user, we have two starter project templates, the [Basic Template](https://github.com/zurb/foundation-sites-template) and the [ZURB Template](https://github.com/zurb/foundation-zurb-template). You can install them by manually downloading them from GitHub, or using the [Foundation CLI](https://github.com/zurb/foundation-cli).
-
-Lastly, if you're rolling your own setup, you can install Foundation through a variety of [package managers](http://foundation.zurb.com/sites/docs/installation.html#package-managers).
+---
-## Documentation
+## Run locally
-The documentation can be found at <https://foundation.zurb.com/sites/docs>. To run the documentation locally on your machine, you need [Node.js](https://nodejs.org/en/) installed on your computer. (Your Node.js version must be **6.4.0** or higher.)
+### Documentation
-Run these commands to set up the documentation:
+To run the documentation locally on your machine, you need [Node.js](https://nodejs.org/en/) installed on your computer. (Your Node.js version must be **6.4.0** or higher). Run these commands to set up the documentation:
```bash
+# Install
git clone https://github.com/zurb/foundation-sites
cd foundation-sites
npm install
-```
-
-Then run `npm start` to compile the documentation. When it finishes, a new browser window will open pointing to a BrowserSync server displaying the documentation.
-
-## Training
-Want the guided tour to Foundation from the team that built it? The ZURB team offers comprehensive training courses for developers of all skill levels. If you're new to Foundation, check out the [Introduction to Foundation Course](http://zurb.com/university/foundation-intro?utm_source=Github%20Repo&utm_medium=website&utm_campaign=readme&utm_content=readme%20training%20link) to kickstart your skills, amplify your productivity, and get a comprehensive overview of everything Foundation has to offer. More Advanced users should check out the [Advanced Foundation Course](http://zurb.com/university/advanced-foundation-training?utm_source=Github%20Repo&utm_medium=website&utm_campaign=readme&utm_content=readme%20training%20link) to learn the Advanced skills that ZURB uses to deliver quality client work in short timeframes.
+# Start the documentation
+npm start
+```
-## Testing
+### Testing
Foundation has three kinds of tests: JavaScript, Sass, and visual regression. Refer to our [testing guide](https://github.com/zurb/foundation-sites/wiki/Testing-Guide) for more details.
-These commands will run the various tests:
-
-- `npm run test:sass`
-- `npm run test:javascript:units`
-- `npm run test:visual`
+Run tests with:
+```bash
+# Sass unit tests
+npm run test:sass
+# JavaScript unit tests
+npm run test:javascript:units
+# Visual tests
+npm run test:visual
+```
Testing Supported By<br/>
<img width="160" src="http://foundation.zurb.com/sites/docs/assets/img/logos/browser-stack.svg" alt="BrowserStack"/>
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.
+## Training
+
+Want the guided tour to Foundation from the team that built it? The ZURB team offers comprehensive training courses for developers of all skill levels. If you're new to Foundation, check out the [Introduction to Foundation Course](http://zurb.com/university/foundation-intro?utm_source=Github%20Repo&utm_medium=website&utm_campaign=readme&utm_content=readme%20training%20link) to kickstart your skills, amplify your productivity, and get a comprehensive overview of everything Foundation has to offer. More advanced users should check out the [Advanced Foundation Course](http://zurb.com/university/advanced-foundation-training?utm_source=Github%20Repo&utm_medium=website&utm_campaign=readme&utm_content=readme%20training%20link) to learn the Advanced skills that ZURB uses to deliver quality client work in short timeframes.
+
Copyright (c) 2018 ZURB, Inc.