Skip to content

Commit afb5fe3

Browse files
v4
2 parents 632166f + b017dbf commit afb5fe3

File tree

154 files changed

+11209
-6850
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

154 files changed

+11209
-6850
lines changed

CONTRIBUTING.md

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
# Contributing to Responsive
2+
3+
Please take a moment to review this document in order to make the contribution
4+
process easy and effective for everyone involved.
5+
6+
Following these guidelines helps to communicate that you respect the time of
7+
the developers managing and developing this open source project. In return,
8+
they should reciprocate that respect in addressing your issue or assessing
9+
patches and features.
10+
11+
12+
## Using the issue tracker
13+
14+
The issue tracker is the preferred channel for [bug reports](#bugs),
15+
[features requests](#features) and [submitting pull
16+
requests](#pull-requests), but please respect the following restrictions:
17+
18+
* Please **do not** use the issue tracker for personal support requests (use
19+
[Gitter](https://gitter.im/ResponsiveBP/Responsive) or Twitter).
20+
21+
* Please **do not** derail or troll issues. Keep the discussion on topic and
22+
respect the opinions of others.
23+
24+
25+
<a name="bugs"></a>
26+
## Bug reports
27+
28+
A bug is a _demonstrable problem_ that is caused by the code in the repository.
29+
Good bug reports are extremely helpful - thank you!
30+
31+
Guidelines for bug reports:
32+
33+
1. **Use the GitHub issue search** &mdash; check if the issue has already been
34+
reported.
35+
36+
2. **Check if the issue has been fixed** &mdash; try to reproduce it using the
37+
latest `master` or development branch in the repository.
38+
39+
3. **Isolate the problem** &mdash; create a [reduced test
40+
case](http://css-tricks.com/6263-reduced-test-cases/) and a live example.
41+
42+
A good bug report shouldn't leave others needing to chase you up for more
43+
information. Please try to be as detailed as possible in your report. What is
44+
your environment? What steps will reproduce the issue? What browser(s) and OS
45+
experience the problem? What would you expect to be the outcome? All these
46+
details will help people to fix any potential bugs.
47+
48+
Example:
49+
50+
> Short and descriptive example bug report title
51+
>
52+
> A summary of the issue and the browser/OS environment in which it occurs. If
53+
> suitable, include the steps required to reproduce the bug.
54+
>
55+
> 1. This is the first step
56+
> 2. This is the second step
57+
> 3. Further steps, etc.
58+
>
59+
> `<url>` - a link to the reduced test case
60+
>
61+
> Any other information you want to share that is relevant to the issue being
62+
> reported. This might include the lines of code that you have identified as
63+
> causing the bug, and potential solutions (and your opinions on their
64+
> merits).
65+
66+
67+
<a name="features"></a>
68+
## Feature requests
69+
70+
Feature requests are welcome. But take a moment to find out whether your idea
71+
fits with the scope and aims of the project. It's up to *you* to make a strong
72+
case to convince the project's developers of the merits of this feature. Please
73+
provide as much detail and context as possible.
74+
75+
76+
<a name="pull-requests"></a>
77+
## Pull requests
78+
79+
Good pull requests - patches, improvements, new features - are a fantastic
80+
help. They should remain focused in scope and avoid containing unrelated
81+
commits.
82+
83+
**Please ask first** before embarking on any significant pull request (e.g.
84+
implementing features, refactoring code, porting to a different language),
85+
otherwise you risk spending a lot of time working on something that the
86+
project's developers might not want to merge into the project.
87+
88+
Please adhere to the coding conventions used throughout a project (indentation,
89+
accurate comments, etc.) and any other requirements (such as test coverage).
90+
91+
Follow this process if you'd like your work considered for inclusion in the
92+
project:
93+
94+
1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
95+
and configure the remotes:
96+
97+
```bash
98+
# Clone your fork of the repo into the current directory
99+
git clone https://github.com/<your-username>/<repo-name>
100+
# Navigate to the newly cloned directory
101+
cd <repo-name>
102+
# Assign the original repo to a remote called "upstream"
103+
git remote add upstream https://github.com/<upstream-owner>/<repo-name>
104+
```
105+
106+
2. If you cloned a while ago, get the latest changes from upstream:
107+
108+
```bash
109+
git checkout <dev-branch>
110+
git pull upstream <dev-branch>
111+
```
112+
113+
3. Create a new topic branch (off the main project development branch) to
114+
contain your feature, change, or fix:
115+
116+
```bash
117+
git checkout -b <topic-branch-name>
118+
```
119+
120+
4. Commit your changes in logical chunks. Please adhere to these [git commit
121+
message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
122+
or your code is unlikely be merged into the main project. Use Git's
123+
[interactive rebase](https://help.github.com/articles/interactive-rebase)
124+
feature to tidy up your commits before making them public.
125+
126+
5. Locally merge (or rebase) the upstream development branch into your topic branch:
127+
128+
```bash
129+
git pull [--rebase] upstream <dev-branch>
130+
```
131+
132+
6. Push your topic branch up to your fork:
133+
134+
```bash
135+
git push origin <topic-branch-name>
136+
```
137+
138+
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
139+
with a clear title and description.
140+
141+
**IMPORTANT**: By submitting a patch, you agree to allow the project owner to
142+
license your work under the same license as that used by the project.

README.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,45 +4,54 @@
44

55
###Responsive is the developers framework.
66

7-
Frameworks like Bootstrap and Foundation are too design opinionated and heavy. They're great for prototyping but every time
7+
Other frameworks are too design opinionated and heavy. They're great for prototyping but every time
88
you start a real, front-facing, project with them you have to overwrite lots of designer styles that do nothing to add to the
99
functionality of the website. That costs developers time and money.
1010

1111
**Responsive** has been built with that in mind. It is the result of thousands of hours of real, client driven web development and
1212
testing; specifically developed to be as lightweight as possible to prevent the need to undo styles set by the framework itself
1313
and allow developers to write efficient code and lower costs.
1414

15-
**Responsive is tiny**. The combined output CSS and JavaScript is **only 25.4kb minified and gzipped** but there is a lot of functionality
16-
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/).
15+
**Responsive is tiny**. The combined output CSS and JavaScript is **only 22.9kb minified and gzipped** but there is a lot of functionality
16+
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
17+
such as you would with [Normalize.css](http://necolas.github.io/normalize.css/).
1718

18-
Browser support covers IE8+ as well as all other modern browsers.
19+
Browser support covers IE9+ as well as all other modern browsers.
1920

2021
##Downloading Responsive
2122

2223
Several options are available for downloading Responsive:
2324

24-
- [Download the latest release](https://github.com/ResponsiveBP/Responsive/releases/download/3.1.0/responsive.zip).
25-
- [Download the latest release source](https://github.com/ResponsiveBP/Responsive/archive/3.1.0.zip).
25+
- [Download the latest release](https://github.com/ResponsiveBP/Responsive/releases/download/4.0.0/responsive.zip).
26+
- [Download the latest release source](https://github.com/ResponsiveBP/Responsive/archive/4.0.0.zip).
2627
- Clone the repo: `git clone https://github.com/ResponsiveBP/Responsive.git`.
2728
- Install with [Bower](http://bower.io): `bower install responsive`.
2829

2930
##Documentation
3031

3132
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.
3233

33-
1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) (requires v2.2).
34+
1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) (requires v2.5.2).
3435
- **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.
35-
2. From the root `/Responsive` directory, run `jekyll serve --watch` in the command line.
36+
2. From the root `/Responsive` directory, run `jekyll serve` in the command line.
3637
- Open [http://localhost:4000](http://localhost:4000) in your browser to view the compiled docs.
3738

3839

3940
Learn more about using Jekyll by reading its [documentation](http://jekyllrb.com/docs/home/).
4041

4142
##Contributing
4243

43-
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.
44+
Contribution is most welcome, that's the whole idea! Together as a community we can build a boilerplate for building
45+
responsive sites that will ensure that high standards can be delivered across all devices.
4446

45-
Please adhere to existing JavaScript and Sass styles though when submitting code and ensure that you test thoroughly on multiple devices.
47+
Please adhere to existing JavaScript and Sass styles though when submitting code and ensure
48+
that you test thoroughly on multiple devices.
49+
50+
Please take a moment to review the [guidelines for contributing](CONTRIBUTING.md).
51+
52+
* [Bug reports](CONTRIBUTING.md#bugs)
53+
* [Feature requests](CONTRIBUTING.md#features)
54+
* [Pull requests](CONTRIBUTING.md#pull-requests)
4655

4756
##Building the Sass and JavaScript
4857

@@ -67,12 +76,13 @@ Have a bug or a feature request? Please open a new [issue](https://github.com/re
6776

6877
##Authors
6978

70-
James South [@james_m_south](http://twitter.com/james_m_south)
79+
James South [@james_m_south](http://twitter.com/james_m_south) and the Responsive contributors.
7180

7281
##Community
7382

7483
Follow [@responsivebp](http://twitter.com/responsivebp) on Twitter.
84+
Discuss Responsive on [Gitter](https://gitter.im/ResponsiveBP/Responsive).
7585

7686
###Copyright and license
7787

78-
Copyright 2013 James South under the [MIT license](http://opensource.org/licenses/MIT).
88+
Copyright 2013-2015 James South under the [MIT license](http://opensource.org/licenses/MIT).

bower.json

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
{
22
"name": "responsive",
33
"description": "A super lightweight HTML, Sass, CSS, and JavaScript framework for building responsive websites.",
4-
"version": "3.1.4",
4+
"version": "4.0.0",
55
"homepage": "http://responsivebp.com",
66
"authors": [
77
"James South"
88
],
99
"keywords": [
10+
"html",
1011
"css",
1112
"js",
1213
"javascript",
@@ -36,9 +37,6 @@
3637
"tests"
3738
],
3839
"dependencies": {
39-
"html5shiv": "3.7.2",
40-
"jquery": "2.1.1",
41-
"jquery-legacy": "jquery#1.11.1",
42-
"respond": "1.4.2"
40+
"jquery": "2.1.3"
4341
}
4442
}

0 commit comments

Comments
 (0)