You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: bootstrap/CONTRIBUTING.md
+27-7Lines changed: 27 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,11 +24,16 @@ restrictions:
24
24
* Please **do not** derail or troll issues. Keep the discussion on topic and
25
25
respect the opinions of others.
26
26
27
+
* Please **do not** post comments consisting solely of "+1" or ":thumbsup:".
28
+
Use [GitHub's "reactions" feature](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments)
29
+
instead. We reserve the right to delete comments which violate this rule.
30
+
27
31
* Please **do not** open issues or pull requests regarding the code in
28
32
[`Normalize`](https://github.com/necolas/normalize.css) (open them in
29
33
their respective repositories).
30
34
31
-
* Please **do not** open issues regarding the official themes offered on <http://themes.getbootstrap.com/>. Instead, please email any questions or feedback regarding those themes to `themes AT getbootstrap DOT com`.
35
+
* Please **do not** open issues regarding the official themes offered on <http://themes.getbootstrap.com/>.
36
+
Instead, please email any questions or feedback regarding those themes to `themes AT getbootstrap DOT com`.
32
37
33
38
34
39
## Issues and labels
@@ -37,7 +42,7 @@ Our bug tracker utilizes several labels to help organize and identify issues. He
37
42
38
43
-`browser bug` - Issues that are reported to us, but actually are the result of a browser-specific bug. These are diagnosed with reduced test cases and result in an issue opened on that browser's own bug tracker.
39
44
-`confirmed` - Issues that have been confirmed with a reduced test case and identify a bug in Bootstrap.
40
-
-`css` - Issues stemming from our compiled CSS or source Less files.
45
+
-`css` - Issues stemming from our compiled CSS or source Less/Sass files.
41
46
-`customizer` - Issues with our web-based Customizer.
42
47
-`docs` - Issues for improving or updating our documentation.
43
48
-`examples` - Issues involving the example templates included in our docs.
@@ -107,7 +112,7 @@ When feasible, we aim to report such upstream bugs to the relevant browser vendo
107
112
| Mozilla | Firefox | Gecko |https://bugzilla.mozilla.org/enter_bug.cgi| "Core" is normally the right product option to choose. |
108
113
| Apple | Safari | WebKit |https://bugs.webkit.org/enter_bug.cgi?product=WebKit <br> https://bugreport.apple.com| In Apple's bug reporter, choose "Safari" as the product. |
109
114
| Google, Opera | Chrome, Chromium, Opera v15+ | Blink |https://code.google.com/p/chromium/issues/list| Click the "New issue" button. |
110
-
| Microsoft |Internet Explorer / Edge| Trident/EdgeHTML |https://connect.microsoft.com/IE/feedback/LoadSubmitFeedbackForm||
115
+
| Microsoft |Edge |EdgeHTML |https://developer.microsoft.com/en-us/microsoft-edge/platform/issues/||
111
116
112
117
### Issues bots
113
118
@@ -116,7 +121,13 @@ When feasible, we aim to report such upstream bugs to the relevant browser vendo
116
121
117
122
## Feature requests
118
123
119
-
Feature requests are welcome. But take a moment to find out whether your idea
124
+
Feature requests are welcome, but please note that they **must target
125
+
[Bootstrap v4](https://github.com/twbs/bootstrap/tree/v4-dev),** because
126
+
Bootstrap v3 is now in maintenance mode and is closed off to new features.
127
+
This is so that we can focus our efforts on Bootstrap v4, the future of the
128
+
framework.
129
+
130
+
Before opening a feature request, please take a moment to find out whether your idea
120
131
fits with the scope and aims of the project. It's up to *you* to make a strong
121
132
case to convince the project's developers of the merits of this feature. Please
122
133
provide as much detail and context as possible.
@@ -133,13 +144,21 @@ implementing features, refactoring code, porting to a different language),
133
144
otherwise you risk spending a lot of time working on something that the
134
145
project's developers might not want to merge into the project.
135
146
147
+
In particular, **pull requests that add new features to Bootstrap v3 will be
148
+
rejected.** Bootstrap v3 is now in maintenance mode and is therefore closed
149
+
off to new features, so that we can focus our efforts on Bootstrap v4, the
150
+
future of the framework. Pull requests that add new features should target
151
+
[Bootstrap v4 (the `v4-dev` git branch)](https://github.com/twbs/bootstrap/tree/v4-dev)
152
+
instead, where they will be welcomed and duly considered.
153
+
136
154
Please adhere to the [coding guidelines](#code-guidelines) used throughout the
137
155
project (indentation, accurate comments, etc.) and any other requirements
138
156
(such as test coverage).
139
157
140
158
**Do not edit `bootstrap.css`, `bootstrap-theme.css`, or `bootstrap.js`
141
159
directly!** Those files are automatically generated. You should edit the
142
-
source files in [`/bootstrap/less/`](https://github.com/twbs/bootstrap/tree/master/less)
160
+
source files in [`/bootstrap/less/`](https://github.com/twbs/bootstrap/tree/master/less),
feature to tidy up your commits before making them public.
185
204
@@ -229,14 +248,15 @@ includes code changes) and under the terms of the
229
248
[Adhere to the Code Guide.](http://codeguide.co/#css)
230
249
231
250
- When feasible, default color palettes should comply with [WCAG color contrast guidelines](http://www.w3.org/TR/WCAG20/#visual-audio-contrast).
232
-
- 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.
251
+
- 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.
233
252
234
253
### JS
235
254
236
255
- No semicolons (in client-side JS)
237
256
- 2 spaces (no tabs)
238
257
- strict mode
239
258
- "Attractive"
259
+
- Don't use [jQuery event alias convenience methods](https://github.com/jquery/jquery/blob/master/src/event/alias.js) (such as `$().focus()`). Instead, use [`$().trigger(eventType, ...)`](http://api.jquery.com/trigger/) or [`$().on(eventType, ...)`](http://api.jquery.com/on/), depending on whether you're firing an event or listening for an event. (For example, `$().trigger('focus')` or `$().on('focus', function (event) { /* handle focus event */ })`) We do this to be compatible with custom builds of jQuery where the event aliases module has been excluded.
@@ -130,7 +129,7 @@ module.exports = function (grunt) {
130
129
warnings: false
131
130
},
132
131
mangle: true,
133
-
preserveComments: 'some'
132
+
preserveComments: /^!|@preserve|@license|@cc_on/i
134
133
},
135
134
core: {
136
135
src: '<%= concat.bootstrap.dest %>',
@@ -232,6 +231,7 @@ module.exports = function (grunt) {
232
231
compatibility: 'ie8',
233
232
keepSpecialComments: '*',
234
233
sourceMap: true,
234
+
sourceMapInlineSources: true,
235
235
advanced: false
236
236
},
237
237
minifyCore: {
@@ -277,7 +277,7 @@ module.exports = function (grunt) {
277
277
copy: {
278
278
fonts: {
279
279
expand: true,
280
-
src: 'fonts/*',
280
+
src: 'fonts/**',
281
281
dest: 'dist/'
282
282
},
283
283
docs: {
@@ -301,7 +301,9 @@ module.exports = function (grunt) {
301
301
302
302
jekyll: {
303
303
options: {
304
-
config: '_config.yml'
304
+
bundleExec: true,
305
+
config: '_config.yml',
306
+
incremental: false
305
307
},
306
308
docs: {},
307
309
github: {
@@ -314,12 +316,27 @@ module.exports = function (grunt) {
314
316
htmlmin: {
315
317
dist: {
316
318
options: {
319
+
collapseBooleanAttributes: true,
317
320
collapseWhitespace: true,
318
321
conservativeCollapse: true,
319
-
minifyCSS: true,
322
+
decodeEntities: false,
323
+
minifyCSS: {
324
+
compatibility: 'ie8',
325
+
keepSpecialComments: 0
326
+
},
320
327
minifyJS: true,
328
+
minifyURLs: false,
329
+
processConditionalComments: true,
321
330
removeAttributeQuotes: true,
322
-
removeComments: true
331
+
removeComments: true,
332
+
removeOptionalAttributes: true,
333
+
removeOptionalTags: true,
334
+
removeRedundantAttributes: true,
335
+
removeScriptTypeAttributes: true,
336
+
removeStyleLinkTypeAttributes: true,
337
+
removeTagWhitespace: false,
338
+
sortAttributes: true,
339
+
sortClassName: true
323
340
},
324
341
expand: true,
325
342
cwd: '_gh_pages',
@@ -331,17 +348,17 @@ module.exports = function (grunt) {
331
348
}
332
349
},
333
350
334
-
jade: {
351
+
pug: {
335
352
options: {
336
353
pretty: true,
337
354
data: getLessVarsData
338
355
},
339
356
customizerVars: {
340
-
src: 'docs/_jade/customizer-variables.jade',
357
+
src: 'docs/_pug/customizer-variables.pug',
341
358
dest: 'docs/_includes/customizer-variables.html'
342
359
},
343
360
customizerNav: {
344
-
src: 'docs/_jade/customizer-nav.jade',
361
+
src: 'docs/_pug/customizer-nav.pug',
345
362
dest: 'docs/_includes/nav/customize.html'
346
363
}
347
364
},
@@ -350,7 +367,7 @@ module.exports = function (grunt) {
350
367
options: {
351
368
ignore: [
352
369
'Attribute "autocomplete" not allowed on element "button" at this point.',
353
-
'Attribute "autocomplete" is only allowed when the input type is "color", "date", "datetime", "datetime-local", "email", "month", "number", "password", "range", "search", "tel", "text", "time", "url", or "week".',
370
+
'Attribute "autocomplete" is only allowed when the input type is "color", "date", "datetime", "datetime-local", "email", "hidden", "month", "number", "password", "range", "search", "tel", "text", "time", "url", or "week".',
354
371
'Element "img" is missing required attribute "src".'
355
372
]
356
373
},
@@ -372,25 +389,6 @@ module.exports = function (grunt) {
372
389
}
373
390
},
374
391
375
-
sed: {
376
-
versionNumber: {
377
-
pattern: (function(){
378
-
varold=grunt.option('oldver');
379
-
returnold ? RegExp.quote(old) : old;
380
-
})(),
381
-
replacement: grunt.option('newver'),
382
-
exclude: [
383
-
'dist/fonts',
384
-
'docs/assets',
385
-
'fonts',
386
-
'js/tests/vendor',
387
-
'node_modules',
388
-
'test-infra'
389
-
],
390
-
recursive: true
391
-
}
392
-
},
393
-
394
392
'saucelabs-qunit': {
395
393
all: {
396
394
options: {
@@ -485,16 +483,11 @@ module.exports = function (grunt) {
0 commit comments