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
Looking to contribute something to Bootstrap? **Here's how you can help.**
3
+
Looking to contribute something to CoreUI? **Here's how you can help.**
4
4
5
-
Please take a moment to review this document in order to make the contribution
6
-
process easy and effective for everyone involved.
5
+
Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
7
6
8
-
Following these guidelines helps to communicate that you respect the time of
9
-
the developers managing and developing this open source project. In return,
10
-
they should reciprocate that respect in addressing your issue or assessing
7
+
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
11
8
patches and features.
12
9
13
-
14
10
## Using the issue tracker
15
11
16
-
The [issue tracker](https://github.com/twbs/bootstrap/issues) is
12
+
The [issue tracker](https://github.com/coreui/coreui/issues) is
17
13
the preferred channel for [bug reports](#bug-reports), [features requests](#feature-requests)
18
14
and [submitting pull requests](#pull-requests), but please respect the following
19
15
restrictions:
20
16
21
-
* Please **do not** use the issue tracker for personal support requests. Stack
[Slack](https://bootstrap-slack.herokuapp.com/) or [IRC](README.md#community) are better places to get help.
24
-
25
-
* Please **do not** derail or troll issues. Keep the discussion on topic and
26
-
respect the opinions of others.
17
+
* Please **do not** use the issue tracker for personal support requests.
27
18
28
19
* Please **do not** post comments consisting solely of "+1" or ":thumbsup:".
29
-
Use [GitHub's "reactions" feature](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/)
30
-
instead. We reserve the right to delete comments which violate this rule.
31
-
32
-
* Please **do not** open issues regarding the official themes offered on <https://themes.getbootstrap.com/>.
33
-
Instead, please email any questions or feedback regarding those themes to `themes AT getbootstrap DOT com`.
34
-
35
-
36
-
## Issues and labels
37
-
38
-
Our bug tracker utilizes several labels to help organize and identify issues. Here's what they represent and how we use them:
39
-
40
-
-`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.
41
-
-`confirmed` - Issues that have been confirmed with a reduced test case and identify a bug in Bootstrap.
42
-
-`css` - Issues stemming from our compiled CSS or source Sass files.
43
-
-`docs` - Issues for improving or updating our documentation.
44
-
-`examples` - Issues involving the example templates included in our docs.
45
-
-`feature` - Issues asking for a new feature to be added, or an existing one to be extended or modified. New features require a minor version bump (e.g., `v3.0.0` to `v3.1.0`).
46
-
-`build` - Issues with our build system, which is used to run all our tests, concatenate and compile source files, and more.
47
-
-`help wanted` - Issues we need or would love help from the community to resolve.
48
-
-`js` - Issues stemming from our compiled or source JavaScript files.
49
-
-`meta` - Issues with the project itself or our GitHub repository.
50
-
51
-
For a complete look at our labels, see the [project labels page](https://github.com/twbs/bootstrap/labels).
52
-
20
+
Use [GitHub's "reactions" feature](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments)
21
+
instead.
53
22
54
23
## Bug reports
55
24
@@ -58,18 +27,13 @@ Good bug reports are extremely helpful, so thanks!
58
27
59
28
Guidelines for bug reports:
60
29
61
-
0.**[Validate your HTML](https://html5.validator.nu/)** to ensure your
62
-
problem isn't caused by a simple error in your own code.
30
+
0.**Validate and lint your code**— to ensure your problem isn't caused by a simple error in your own code.
63
31
64
-
1.**Use the GitHub issue search**— check if the issue has already been
65
-
reported.
32
+
1.**Use the GitHub issue search**— check if the issue has already been reported.
66
33
67
-
2.**Check if the issue has been fixed**— try to reproduce it using the
68
-
latest `main` (or `v4-dev` branch if the issue is about v4) in the repository.
34
+
2.**Check if the issue has been fixed**— try to reproduce it using the latest `master` or development branch in the repository.
69
35
70
-
3.**Isolate the problem**— ideally create a [reduced test
71
-
case](https://css-tricks.com/reduced-test-cases/) and a live example.
72
-
[This JS Bin](https://jsbin.com/lolome/edit?html,output) is a helpful template.
36
+
3.**Isolate the problem**— ideally create a [reduced test case](https://css-tricks.com/reduced-test-cases/) and a live example. [This JS Bin](http://jsbin.com/lefey/1/edit?html,output) is a helpful template.
73
37
74
38
75
39
A good bug report shouldn't leave others needing to chase you up for more
@@ -97,24 +61,13 @@ Example:
97
61
> causing the bug, and potential solutions (and your opinions on their
98
62
> merits).
99
63
100
-
### Reporting upstream browser bugs
101
-
102
-
Sometimes bugs reported to us are actually caused by bugs in the browser(s) themselves, not bugs in Bootstrap per se.
* test (adding missing tests, refactoring tests; no production code change) -> ```git test -m 'refactor: commit-message-here'```
204
150
205
151
## Code guidelines
206
152
207
153
### HTML
208
154
209
-
[Adhere to the Code Guide.](https://codeguide.co/#html)
155
+
[Adhere to the Code Guide.](http://codeguide.co/#html)
210
156
211
157
- Use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags).
212
158
- 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://`.
213
159
- Use [WAI-ARIA](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) attributes in documentation examples to promote accessibility.
214
160
215
161
### CSS
216
162
217
-
[Adhere to the Code Guide.](https://codeguide.co/#css)
163
+
[Adhere to the Code Guide.](http://codeguide.co/#css)
218
164
219
-
- When feasible, default color palettes should comply with [WCAG color contrast guidelines](https://www.w3.org/TR/WCAG20/#visual-audio-contrast).
220
-
- Except in rare cases, don't remove default `:focus` styles (via e.g. `outline: none;`) without providing alternative styles. See [this A11Y Project post](https://www.a11yproject.com/posts/2013-01-25-never-remove-css-outlines/) for more details.
165
+
- When feasible, default color palettes should comply with [WCAG color contrast guidelines](http://www.w3.org/TR/WCAG20/#visual-audio-contrast).
166
+
- 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.
221
167
222
168
### JS
223
169
224
170
- No semicolons (in client-side JS)
225
171
- 2 spaces (no tabs)
226
172
- strict mode
227
173
- "Attractive"
228
-
229
-
### Checking coding style
230
-
231
-
Run `npm run test` before committing to ensure your changes follow our coding standards.
232
-
174
+
- 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.
233
175
234
176
## License
235
177
236
-
By contributing your code, you agree to license your contribution under the [MIT License](../LICENSE).
237
-
By contributing to the documentation, you agree to license your contribution under the [Creative Commons Attribution 3.0 Unported License](https://creativecommons.org/licenses/by/3.0/).
238
-
239
-
Prior to v3.1.0, Bootstrap's code was released under the Apache License v2.0.
178
+
By contributing your code, you agree to license your contribution under the [MIT License](LICENSE).
0 commit comments