CONTRIBUTING.md 7.1 KB
Newer Older
Mark Otto's avatar
Mark Otto committed
1
2
# Contributing to Bootstrap

3
Looking to contribute something to Bootstrap? **Here's how you can help.**
Chris Aniszczyk's avatar
Chris Aniszczyk committed
4

5
6
Please take a moment to review this document in order to make the contribution
process easy and effective for everyone involved.
Chris Aniszczyk's avatar
Chris Aniszczyk committed
7

8
9
10
11
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.
12
13


14
## Using the issue tracker
15

16
17
18
19
The [issue tracker](https://github.com/twbs/bootstrap/issues) is
the preferred channel for [bug reports](#bug-reports), [features requests](#feature-requests)
and [submitting pull requests](#pull-requests), but please respect the following
restrictions:
20

21
* Please **do not** use the issue tracker for personal support requests.  Stack
22
  Overflow ([`twitter-bootstrap-3`](http://stackoverflow.com/questions/tagged/twitter-bootstrap-3) tag) or [IRC](https://github.com/twbs/bootstrap/blob/master/README.md#community) are better places to get help.
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

* Please **do not** derail or troll issues. Keep the discussion on topic and
  respect the opinions of others.

* Please **do not** open issues or pull requests regarding the code in
  [`Normalize`](https://github.com/necolas/normalize.css) (open them in
  their respective repositories).


## Bug reports

A bug is a _demonstrable problem_ that is caused by the code in the repository.
Good bug reports are extremely helpful, so thanks!

Guidelines for bug reports:

39
40
41
42
0. **Validate and lint your code** — [validate your HTML](http://html5.validator.nu)
   and [lint your HTML](https://github.com/twbs/bootlint) to ensure your
   problem isn't caused by a simple error in your own code.

43
44
45
46
47
48
49
50
1. **Use the GitHub issue search** — check if the issue has already been
   reported.

2. **Check if the issue has been fixed** — try to reproduce it using the
   latest `master` or development branch in the repository.

3. **Isolate the problem** — ideally create a [reduced test
   case](http://css-tricks.com/6263-reduced-test-cases/) and a live example.
51
   [This JS Bin](http://jsbin.com/lefey/1/edit?html,output) is a helpful template.
52

53
54
55
56

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
57
58
59
experience the problem? Do other browsers show the bug differently? What
would you expect to be the outcome? All these details will help people to fix
any potential bugs.
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

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).


## 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.
86
87
88
89


## Pull requests

90
91
92
93
94
95
96
97
98
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.

99
Please adhere to the [coding guidelines](#code-guidelines) used throughout the
100
101
project (indentation, accurate comments, etc.) and any other requirements
(such as test coverage).
Chris Aniszczyk's avatar
Chris Aniszczyk committed
102

103
Adhering to the following process is the best way to get your work
104
included in the project:
105

106
107
1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
   and configure the remotes:
108

109
110
111
112
   ```bash
   # Clone your fork of the repo into the current directory
   git clone https://github.com/<your-username>/bootstrap.git
   # Navigate to the newly cloned directory
113
   cd bootstrap
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
   # Assign the original repo to a remote called "upstream"
   git remote add upstream https://github.com/twbs/bootstrap.git
   ```

2. If you cloned a while ago, get the latest changes from upstream:

   ```bash
   git checkout master
   git pull upstream master
   ```

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 master
   ```

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 against the `master` branch.

**IMPORTANT**: By submitting a patch, you agree to allow the project owners to
Zlatan Vasović's avatar
Zlatan Vasović committed
154
license your work under the terms of the [MIT License](LICENSE.md).
155
156
157


## Code guidelines
Mark Otto's avatar
Mark Otto committed
158
159

### HTML
160

Mark Otto's avatar
Mark Otto committed
161
162
[Adhere to the Code Guide.](http://codeguide.co/#html)

163
- Use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags).
164
- Use CDNs and HTTPS for third-party JS when possible. We don't use protocol-relative URLs in this case because they break when viewing the page locally via `file://`.
165
- Use [WAI-ARIA](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) attributes in documentation examples to promote accessibility.
Chris Aniszczyk's avatar
Chris Aniszczyk committed
166

Mark Otto's avatar
Mark Otto committed
167
### CSS
168

Mark Otto's avatar
Mark Otto committed
169
170
[Adhere to the Code Guide.](http://codeguide.co/#css)

171
- When feasible, default color palettes should comply with [WCAG color contrast guidelines](http://www.w3.org/TR/WCAG20/#visual-audio-contrast).
172
- Except in rare cases, don't remove default `:focus` styles (via e.g. `outline: none;`) without providing alternative styles. See [this A11Y Project post](http://a11yproject.com/posts/never-remove-css-outlines/) for more details.
Chris Aniszczyk's avatar
Chris Aniszczyk committed
173

Mark Otto's avatar
Mark Otto committed
174
### JS
fat's avatar
fat committed
175

176
- No semicolons (in client-side JS)
fat's avatar
fat committed
177
178
179
180
- 2 spaces (no tabs)
- strict mode
- "Attractive"

Zlatan Vasović's avatar
Zlatan Vasović committed
181
182
183
184
### Checking coding style

Run `grunt test` before committing to ensure your changes follow our coding standards.

fat's avatar
fat committed
185

186
187
## License

188
By contributing your code, you agree to license your contribution under the [MIT license](https://github.com/twbs/bootstrap/blob/master/LICENSE).
189

190
Prior to v3.1.0, Bootstrap was released under the Apache License v2.0.