Permalink
Browse files

Updating readme etc.

  • Loading branch information...
1 parent e5f0ac0 commit 6e58f133f8bd31452e7bbd31b7ed4ade85648d4e @JimBobSquarePants JimBobSquarePants committed Jan 7, 2015
Showing with 164 additions and 12 deletions.
  1. +142 −0 CONTRIBUTING.md
  2. +22 −12 README.md
View
@@ -0,0 +1,142 @@
+# Contributing to Responsive
+
+Please take a moment to review this document in order to make the contribution
+process easy and effective for everyone involved.
+
+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.
+
+
+## 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
+ [Gitter](https://gitter.im/ResponsiveBP/Responsive) or Twitter).
+
+* 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** &mdash; create a [reduced test
+ case](http://css-tricks.com/6263-reduced-test-cases/) and a live example.
+
+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. What is
+your environment? What steps will reproduce the issue? What browser(s) and OS
+experience the problem? What would you expect to be the outcome? All these
+details will help people to fix any potential bugs.
+
+Example:
+
+> Short and descriptive example bug report title
+>
+> A summary of the issue and the browser/OS environment in which it occurs. If
+> suitable, include the steps required to reproduce the bug.
+>
+> 1. This is the first step
+> 2. This is the second step
+> 3. Further steps, etc.
+>
+> `<url>` - a link to the reduced test case
+>
+> Any other information you want to share that is relevant to the issue being
+> reported. This might include the lines of code that you have identified as
+> causing the bug, and potential solutions (and your opinions on their
+> merits).
+
+
+<a name="features"></a>
+## Feature requests
+
+Feature requests are welcome. But take a moment to find out whether your idea
+fits with the scope and aims of the project. It's up to *you* to make a strong
+case to convince the project's 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
+help. They should remain focused in scope and avoid containing unrelated
+commits.
+
+**Please ask first** before embarking on any significant pull request (e.g.
+implementing features, refactoring code, porting to a different language),
+otherwise you risk spending a lot of time working on something that the
+project's developers might not want to merge into the project.
+
+Please adhere to the coding conventions used throughout a project (indentation,
+accurate comments, etc.) and any other requirements (such as test coverage).
+
+Follow this process if you'd like your work considered for inclusion in the
+project:
+
+1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
+ and configure the remotes:
+
+ ```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/<upstream-owner>/<repo-name>
+ ```
+
+2. If you cloned a while ago, get the latest changes from upstream:
+
+ ```bash
+ git checkout <dev-branch>
+ git pull upstream <dev-branch>
+ ```
+
+3. Create a new topic branch (off the main project development branch) to
+ contain your feature, change, or fix:
+
+ ```bash
+ 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.
+
+5. Locally merge (or rebase) the upstream development branch into your topic branch:
+
+ ```bash
+ git pull [--rebase] upstream <dev-branch>
+ ```
+
+6. Push your topic branch up to your fork:
+
+ ```bash
+ git push origin <topic-branch-name>
+ ```
+
+7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
+ with a clear title and description.
+
+**IMPORTANT**: By submitting a patch, you agree to allow the project owner to
+license your work under the same license as that used by the project.
View
@@ -3,45 +3,54 @@
###Responsive is the developers framework.
-Frameworks like Bootstrap and Foundation are too design opinionated and heavy. They're great for prototyping but every time
+Other frameworks are too design opinionated and heavy. They're great for prototyping but every time
you start a real, front-facing, project with them you have to overwrite lots of designer styles that do nothing to add to the
functionality of the website. That costs developers time and money.
**Responsive** has been built with that in mind. It is the result of thousands of hours of real, client driven web development and
testing; specifically developed to be as lightweight as possible to prevent the need to undo styles set by the framework itself
and allow developers to write efficient code and lower costs.
-**Responsive is tiny**. The combined output CSS and JavaScript is **only 25.4kb minified and gzipped** but there is a lot of functionality
-built into the framework with touch, right-to-left language, and accessibility support. It's designed to be dropped-in, as-is to your website such as you would with [Normalize.css](http://necolas.github.io/normalize.css/).
+**Responsive is tiny**. The combined output CSS and JavaScript is **only 22.9kb minified and gzipped** but there is a lot of functionality
+built into the framework with touch, right-to-left language, and accessibility support. It's designed to be dropped-in, as-is to your website
+such as you would with [Normalize.css](http://necolas.github.io/normalize.css/).
-Browser support covers IE8+ as well as all other modern browsers.
+Browser support covers IE9+ as well as all other modern browsers.
##Downloading Responsive
Several options are available for downloading Responsive:
-- [Download the latest release](https://github.com/ResponsiveBP/Responsive/releases/download/3.1.0/responsive.zip).
-- [Download the latest release source](https://github.com/ResponsiveBP/Responsive/archive/3.1.0.zip).
+- [Download the latest release](https://github.com/ResponsiveBP/Responsive/releases/download/4.0.0/responsive.zip).
+- [Download the latest release source](https://github.com/ResponsiveBP/Responsive/archive/4.0.0.zip).
- Clone the repo: `git clone https://github.com/ResponsiveBP/Responsive.git`.
- Install with [Bower](http://bower.io): `bower install responsive`.
##Documentation
Responsives' documentation, included in the [gh-pages](https://github.com/ResponsiveBP/Responsive/tree/gh-pages) repo. It is built with [Jekyll](http://jekyllrb.com) and publicly hosted on GitHub Pages at [http://responsivebp.com](http://responsivebp.com). The docs may also be run locally.
-1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) (requires v2.2).
+1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) (requires v2.5.2).
- **If you are running Windows** please read this [unofficial guide](https://github.com/juthilo/run-jekyll-on-windows/) to get Jekyll up and running without problems.
-2. From the root `/Responsive` directory, run `jekyll serve --watch` in the command line.
+2. From the root `/Responsive` directory, run `jekyll serve` in the command line.
- Open [http://localhost:4000](http://localhost:4000) in your browser to view the compiled docs.
Learn more about using Jekyll by reading its [documentation](http://jekyllrb.com/docs/home/).
##Contributing
-Contribution is most welcome, that's the whole idea! Together as a community we can build a boilerplate for building responsive sites that will ensure that high standards can be delivered across all devices.
+Contribution is most welcome, that's the whole idea! Together as a community we can build a boilerplate for building
+responsive sites that will ensure that high standards can be delivered across all devices.
-Please adhere to existing JavaScript and Sass styles though when submitting code and ensure that you test thoroughly on multiple devices.
+Please adhere to existing JavaScript and Sass styles though when submitting code and ensure
+that you test thoroughly on multiple devices.
+
+Please take a moment to review the [guidelines for contributing](CONTRIBUTING.md).
+
+* [Bug reports](CONTRIBUTING.md#bugs)
+* [Feature requests](CONTRIBUTING.md#features)
+* [Pull requests](CONTRIBUTING.md#pull-requests)
##Building the Sass and JavaScript
@@ -66,12 +75,13 @@ Have a bug or a feature request? Please open a new [issue](https://github.com/re
##Authors
-James South [@james_m_south](http://twitter.com/james_m_south)
+James South [@james_m_south](http://twitter.com/james_m_south) and the Responsive contributors.
##Community
Follow [@responsivebp](http://twitter.com/responsivebp) on Twitter.
+Discuss Responsive on [Gitter](https://gitter.im/ResponsiveBP/Responsive).
###Copyright and license
-Copyright 2013 James South under the [MIT license](http://opensource.org/licenses/MIT).
+Copyright 2013-2015 James South under the [MIT license](http://opensource.org/licenses/MIT).

0 comments on commit 6e58f13

Please sign in to comment.