Merge pull request roots#852 from roots/6.5.0

Roots 6.5.0

CHANGELOG.md

@@ -1,4 +1,7 @@
-### HEAD
+### 6.5.0: August 23rd, 2013
+* Reference new site, [http://roots.io/](http://roots.io/)
+* Remove bundled docs, reference [http://roots.io/docs/](http://roots.io/docs/)
+* Use Bootstrap variables for media queries
 * Update to Bootstrap 3.0.0
 * Update to jQuery 1.10.2
 * Change media directory from `/assets/` to `/media/`
@@ -15,9 +18,9 @@
 ### 6.4.0: May 1st, 2013
 * Fix Theme Activation page issues
 * Fix issues with root relative URLs and rewrites on non-standard setups
-* Make sure rewrites are added to .htaccess immediately after activation
-* Move HTML5 Boilerplate's .htaccess to a [plugin](https://github.com/retlehs/wp-h5bp-htaccess)
-* Rename page-custom.php to template-custom.php
+* Make sure rewrites are added to `.htaccess` immediately after activation
+* Move HTML5 Boilerplate's `.htaccess` to a [plugin](https://github.com/roots/wp-h5bp-htaccess)
+* Rename `page-custom.php` to `template-custom.php`
 * Don't warn about unwritable htaccess if that option is disabled
 * Add missing collapse class for top navbar
 * Add comment template

CONTRIBUTING.md

@@ -1,74 +1,121 @@
 # Contributing to Roots Theme
 
-## Reporting issues
+Please take a moment to review this document in order to make the contribution
+process easy and effective for everyone involved.
 
-**We only accept issues that are bug reports or feature requests.** Bugs must
- be isolated and reproducible problems that we can fix within Roots. Please
- read the following guidelines before [opening any issues](https://github.com/retlehs/roots/issues):
+Following these guidelines helps to communicate that you respect the time of
+the developers managing and developing this open source project. In return,
+they should reciprocate that respect in addressing your issue or assessing
+patches and features.
 
-1. **Use the GitHub issue search.** Check to see if the issue has already been
-reported. If it has been, please comment on the existing issue. An existing
-issue may also already have a fix available.
 
-2. **Isolate the problem to Roots.** Make sure that the code in the Roots
+## Using the issue tracker
+
+The issue tracker is the preferred channel for [bug reports](#bugs),
+[features requests](#features) and [submitting pull
+requests](#pull-requests), but please respect the following restrictions:
+
+* Please **do not** use the issue tracker for personal support requests (use the
+  [Roots Discourse](http://discourse.roots.io/)).
+
+* Please **do not** derail or troll issues. Keep the discussion on topic and
+  respect the opinions of others.
+
+
+<a name="bugs"></a>
+## Bug reports
+
+A bug is a _demonstrable problem_ that is caused by the code in the repository.
+Good bug reports are extremely helpful - thank you!
+
+Guidelines for bug reports:
+
+1. **Use the GitHub issue search** &mdash; check if the issue has already been
+   reported.
+
+2. **Check if the issue has been fixed** &mdash; try to reproduce it using the
+   latest `master` or development branch in the repository.
+
+3. **Isolate the problem to Roots** &mdash; make sure that the code in the Roots
 repository is _definitely_ responsible for the issue. Switch to a core WordPress
-theme (such as Twenty Twelve) to confirm problems before reporting an issue.
+theme (such as Twenty Thirteen) to confirm problems before reporting an issue.
 Make sure you have reproduced the bug with all plugins disabled. Any issues
 related to HTML5 Boilerplate or Bootstrap should be reported to their respected
 repositories and follow their contributing guidelines.
 
-3. **Do not use GitHub issues for questions or support.** If you have a question
-or support request, please post on the [Google Group](http://groups.google.com/group/roots-theme).
+A good bug report shouldn't leave others needing to chase you up for more
+information. Please try to be as detailed as possible in your report.
+
 
-Please try to be as detailed as possible in your report. What steps will
-reproduce the issue? What would you expect to be the outcome? All these details
-will help people to assess and fix any potential bugs. A good bug report
-shouldn't leave people needing to chase you up to get further information.
+<a name="features"></a>
+## Feature requests
 
-**[File a bug report](https://github.com/retlehs/roots/issues)**
+Feature requests are welcome. But take a moment to find out whether your idea
+fits with the scope and aims of Roots. It's up to *you* to make a strong
+case to convince the Roots developers of the merits of this feature. Please
+provide as much detail and context as possible.
 
 
+<a name="pull-requests"></a>
 ## Pull requests
 
-Good pull requests — patches, improvements, new features — are a fantastic
+Good pull requests - patches, improvements, new features - are a fantastic
 help. They should remain focused in scope and avoid containing unrelated
 commits.
 
-If your contribution involves a significant amount of work or substantial
-changes to any part of the project, please open an issue to discuss it first.
+**Please ask first** before embarking on any significant pull request (e.g.
+implementing features, refactoring code), otherwise you risk spending a lot of
+time working on something that the developers might not want to merge into Roots.
+
+Please adhere to the coding conventions used throughout the project (indentation,
+comments, etc.).
+
+Adhering to the following this process is the best way to get your work
+included in Roots:
+
+1. [Fork](http://help.github.com/fork-a-repo/) Roots, clone your fork,
+   and configure the remotes:
 
-Please follow this process; it's the best way to get your work included in the
-project:
+   ```bash
+   # Clone your fork of the repo into the current directory
+   git clone https://github.com/<your-username>/<repo-name>
+   # Navigate to the newly cloned directory
+   cd <repo-name>
+   # Assign the original repo to a remote called "upstream"
+   git remote add upstream https://github.com/<upsteam-owner>/<repo-name>
+   ```
 
-1. [Fork](https://help.github.com/articles/fork-a-repo) the project.
+2. If you cloned a while ago, get the latest changes from upstream:
 
-2. Clone your fork (`git clone
-   https://github.com/<your-username>/roots.git`).
+   ```bash
+   git checkout <dev-branch>
+   git pull upstream <dev-branch>
+   ```
 
-3. Add an `upstream` remote (`git remote add upstream
-   https://github.com/retlehs/roots.git`).
+3. Create a new topic branch (off the main project development branch) to
+   contain your feature, change, or fix:
 
-4. Get the latest changes from upstream (`git pull upstream
-   master`).
+   ```bash
+   git checkout -b <topic-branch-name>
+   ```
 
-5. Create a new topic branch to contain your feature, change, or fix (`git
-   checkout -b <topic-branch-name>`).
+4. Commit your changes in logical chunks. Please adhere to these [git commit
+   message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+   or your code is unlikely be merged into the main project. Use Git's
+   [interactive rebase](https://help.github.com/articles/interactive-rebase)
+   feature to tidy up your commits before making them public.
 
-6. Make sure that your changes adhere to the current coding conventions used
-   throughout the project - indentation, accurate comments, etc. Please update
-   any documentation that is relevant to the change you are making.
+5. Locally merge (or rebase) the upstream development branch into your topic branch:
 
-7. Commit your changes in logical chunks; use git's [interactive
-   rebase](https://help.github.com/articles/interactive-rebase) feature to tidy
-   up your commits before making them public. Please adhere to these [git commit
-   message
-   guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
-   or your pull request is unlikely be merged.
+   ```bash
+   git pull [--rebase] upstream <dev-branch>
+   ```
 
-8. Locally merge (or rebase) the upstream branch into your topic branch.
+6. Push your topic branch up to your fork:
 
-9. Push your topic branch up to your fork (`git push origin
-   <topic-branch-name>`).
+   ```bash
+   git push origin <topic-branch-name>
+   ```
 
-10. [Open a Pull Request](https://help.github.com/articles/using-pull-requests) with a
-    clear title and description.
+10. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
+    with a clear title and description.

Gruntfile.js

@@ -48,14 +48,6 @@ module.exports = function(grunt) {
         }
       }
     },
-    imageoptim: {
-      files: [
-        'assets/img'
-      ],
-      options: {
-        quitAfter: true
-      }
-    },
     watch: {
       less: {
         files: [
@@ -86,14 +78,12 @@ module.exports = function(grunt) {
   grunt.loadNpmTasks('grunt-contrib-uglify');
   grunt.loadNpmTasks('grunt-contrib-watch');
   grunt.loadNpmTasks('grunt-recess');
-  grunt.loadNpmTasks('grunt-imageoptim');
 
   // Register tasks
   grunt.registerTask('default', [
     'clean',
     'recess',
     'uglify',
-    'imageoptim',
     'version'
   ]);
   grunt.registerTask('dev', [

README.md

@@ -1,75 +1,82 @@
-# [Roots Theme](http://www.rootstheme.com/)
+# [Roots Theme](http://roots.io/)
 
-Roots is a starting WordPress theme made for developers that’s based on
-[HTML5 Boilerplate](http://html5boilerplate.com/) and [Bootstrap from Twitter](http://twitter.github.com/bootstrap/).
+Roots is a WordPress starter theme based on [HTML5 Boilerplate](http://html5boilerplate.com/) & [Bootstrap](http://getbootstrap.com/) that will help you make better themes.
 
-* Source: [https://github.com/retlehs/roots](https://github.com/retlehs/roots)
-* Home Page: [http://www.rootstheme.com/](http://www.rootstheme.com/)
+* Source: [https://github.com/roots/roots](https://github.com/roots/roots)
+* Home Page: [http://roots.io/](http://roots.io/)
 * Twitter: [@retlehs](https://twitter.com/retlehs)
-* Newsletter: [Subscribe](http://www.rootstheme.com/subscribe/)
-* Google Group: [http://groups.google.com/group/roots-theme](http://groups.google.com/group/roots-theme)
+* Newsletter: [Subscribe](http://roots.io/subscribe/)
+* Forum: [http://discourse.roots.io/](http://discourse.roots.io/)
 
 ## Installation
 
-* Clone the git repo - `git clone git://github.com/retlehs/roots.git` - or [download it](https://github.com/retlehs/roots/zipball/master)
-* Reference the [theme activation](doc/activation.md) documentation to understand
-everything that happens once you activate Roots
+Clone the git repo - `git clone git://github.com/roots/roots.git` - or [download it](https://github.com/roots/roots/zipball/master) and then rename the directory to the name of your theme or website. [Install Grunt](http://gruntjs.com/getting-started), and then install the dependencies for Roots contained in `package.json`:
+
+```
+npm install
+```
+
+If you're using Nginx you'll need to add the Roots rewrites to your server config before the PHP block (`location ~ \.php$`) to use the clean URLs feature:
+
+```nginx
+location ~ ^/assets/(img|js|css)/(.*)$ {
+  try_files $uri $uri/ /wp-content/themes/roots/assets/$1/$2;
+}
+location ~ ^/plugins/(.*)$ {
+  try_files $uri $uri/ /wp-content/plugins/$1;
+}
+```
+
+Reference the [theme activation](http://roots.io/roots-101/#theme-activation) documentation to understand everything that happens once you activate Roots.
+
+## Theme Development
+
+After you've installed Grunt and ran `npm install` from the theme root, use `grunt watch` to watch for updates to your LESS and JS files and Grunt will automatically re-build as you write your code.
 
 ## Configuration
 
-Edit `lib/config.php` to enable or disable support for various theme functions
-and to define constants that are used throughout the theme.
+Edit `lib/config.php` to enable or disable support for various theme functions and to define constants that are used throughout the theme.
 
 Edit `lib/init.php` to setup custom navigation menus and post thumbnail sizes.
 
 ## Documentation
 
-Take a look at the [documentation table of contents](doc/TOC.md).
+### [Roots Docs](http://roots.io/docs/)
+
+* [Roots 101](http://roots.io/roots-101/) — A guide to installing Roots, the files and theme organization
+* [Theme Wrapper](http://roots.io/an-introduction-to-the-roots-theme-wrapper/) — Learn all about the theme wrapper
+* [Build Script](http://roots.io/using-grunt-for-wordpress-theme-development/) — A look into the Roots build script powered by Grunt
+* [Roots Sidebar](http://roots.io/the-roots-sidebar/) — Understand how to display or hide the sidebar in Roots
 
 ## Features
 
-* HTML5 Boilerplate’s markup
-* Bootstrap from Twitter
-* [Theme wrapper](doc/wrapper.md)
+* Organized file and template structure
+* HTML5 Boilerplate's markup along with ARIA roles and microformat
+* Bootstrap
+* [Grunt build script](http://roots.io/using-grunt-for-wordpress-theme-development/)
+* [Theme activation](http://roots.io/getting-started/#theme-activation)
+* [Theme wrapper](http://roots.io/an-introduction-to-the-roots-theme-wrapper/)
 * Root relative URLs
 * Clean URLs (no more `/wp-content/`)
-* All static theme assets are rewritten to the website root (`/assets/css/`,
-`/assets/img/`, and `/assets/js/`)
+* All static theme assets are rewritten to the website root (`/assets/*`)
 * Cleaner HTML output of navigation menus
 * Cleaner output of `wp_head` and enqueued scripts/styles
+* Nice search (`/search/query/`)
+* Image captions use `<figure>` and `<figcaption>`
+* Example vCard widget
 * Posts use the [hNews](http://microformats.org/wiki/hnews) microformat
-* [Multilingual ready](http://www.rootstheme.com/wpml/) (Brazilian Portuguese,
-Bulgarian, Catalan, Danish, Dutch, English, Finnish, French, German, Hungarian,
-Indonesian, Italian, Korean, Macedonian, Norwegian, Polish, Russian, Simplified
-Chinese, Spanish, Swedish, Traditional Chinese, Turkish, Vietnamese, Serbian)
-
-### Build Script
-
-The [grunt branch](https://github.com/retlehs/roots/tree/grunt) contains a build
-script powered by grunt. More information can be found at [Integrating grunt.js with Roots](http://benword.com/integrating-grunt-js-with-roots/).
-
-* Easily compile LESS files
-* Minification and concatenation without plugins
-* Fewer requests made to the server (one CSS file, one main JS file besides
-Modernizr and jQuery)
-* Ensures valid JavaScript
-* Others working on your project are able to use the same build script and have
-a unified development process
-* Code is optimized for production use
+* [Multilingual ready](http://roots.io/wpml/) (Brazilian Portuguese, Bulgarian, Catalan, Danish, Dutch, English, Finnish, French, German, Hungarian, Indonesian, Italian, Korean, Macedonian, Norwegian, Polish, Russian, Simplified Chinese, Spanish, Swedish, Traditional Chinese, Turkish, Vietnamese, Serbian)
 
 ## Contributing
 
-Everyone is welcome to help [contribute](CONTRIBUTING.md) and improve this project.
-There are several ways you can contribute:
+Everyone is welcome to help [contribute](CONTRIBUTING.md) and improve this project. There are several ways you can contribute:
 
 * Reporting issues (please read [issue guidelines](https://github.com/necolas/issue-guidelines))
 * Suggesting new features
-* Writing or editing [docs](doc/TOC.md)
 * Writing or refactoring code
-* Fixing [issues](https://github.com/retlehs/roots/issues)
-* Replying to questions on the [Google Group](http://groups.google.com/group/roots-theme)
+* Fixing [issues](https://github.com/roots/roots/issues)
+* Replying to questions on the [forum](http://discourse.roots.io/)
 
 ## Support
 
-Use the [Google Group](http://groups.google.com/group/roots-theme) to ask
-questions and get support.
+Use the [Roots Discourse](http://discourse.roots.io/) to ask questions and get support.