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: .github/CONTRIBUTING.md
+36-22Lines changed: 36 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Contributing to Bootstrap
2
2
3
-
Looking to contribute something to Bootstrap? **Here's how you can help.**
3
+
Looking to contribute something to Bootstrap? **Here’s how you can help.**
4
4
5
5
Please take a moment to review this document in order to make the contribution
6
6
process easy and effective for everyone involved.
@@ -33,14 +33,14 @@ restrictions:
33
33
34
34
## Issues assignment
35
35
36
-
The core team will be looking at the open issues, analyze them, and provide guidance on how to proceed. **Issues won't be assigned to anyone outside the core team.** However, contributors are welcome to participate in the discussion and provide their input on how to best solve the issue, and even submit a PR if they want to. Please wait that the issue is ready to be worked on before submitting a PR, we don't want to waste your time.
36
+
The core team will be looking at the open issues, analyze them, and provide guidance on how to proceed. **Issues won’t be assigned to anyone outside the core team.** However, contributors are welcome to participate in the discussion and provide their input on how to best solve the issue, and even submit a PR if they want to. Please wait that the issue is ready to be worked on before submitting a PR, we don’t want to waste your time.
37
37
38
-
Please keep in mind that the core team is small, has limited resources and that we are not always able to respond immediately. We will try to provide feedback as soon as possible, but please be patient. If you don't get a response immediately, it doesn't mean that we are ignoring you or that we don't care about your issue or PR. We will get back to you as soon as we can.
38
+
Please keep in mind that the core team is small, has limited resources and that we are not always able to respond immediately. We will try to provide feedback as soon as possible, but please be patient. If you don’t get a response immediately, it doesn’t mean that we are ignoring you or that we don’t care about your issue or PR. We will get back to you as soon as we can.
39
39
40
40
41
41
## Issues and labels
42
42
43
-
Our bug tracker utilizes several labels to help organize and identify issues. Here's what they represent and how we use them:
43
+
Our bug tracker utilizes several labels to help organize and identify issues. Here’s what they represent and how we use them:
44
44
45
45
-`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.
46
46
-`confirmed` - Issues that have been confirmed with a reduced test case and identify a bug in Bootstrap.
@@ -64,7 +64,7 @@ Good bug reports are extremely helpful, so thanks!
64
64
Guidelines for bug reports:
65
65
66
66
0.**[Validate your HTML](https://html5.validator.nu/)** to ensure your
67
-
problem isn't caused by a simple error in your own code.
67
+
problem isn’t caused by a simple error in your own code.
68
68
69
69
1.**Use the GitHub issue search**— check if the issue has already been
70
70
reported.
@@ -77,7 +77,7 @@ Guidelines for bug reports:
77
77
These [v4 CodePen](https://codepen.io/team/bootstrap/pen/yLabNQL) and [v5 CodePen](https://codepen.io/team/bootstrap/pen/qBamdLj) are helpful templates.
78
78
79
79
80
-
A good bug report shouldn't leave others needing to chase you up for more
80
+
A good bug report shouldn’t leave others needing to chase you up for more
81
81
information. Please try to be as detailed as possible in your report. What is
82
82
your environment? What steps will reproduce the issue? What browser(s) and OS
83
83
experience the problem? Do other browsers show the bug differently? What
@@ -109,16 +109,16 @@ Sometimes bugs reported to us are actually caused by bugs in the browser(s) them
feature to tidy up your commits before making them public.
187
193
188
-
5. Locally merge (or rebase) the upstream development branch into your topic branch:
194
+
6. Ensure your changes compile the dist CSS and JS files in the `dist/` directory. Verify
195
+
the build succeeds locally without errors.
196
+
197
+
```bash
198
+
npm run dist
199
+
```
200
+
201
+
7. Locally merge (or rebase) the upstream development branch into your topic branch:
189
202
190
203
```bash
191
204
git pull [--rebase] upstream main
192
205
```
193
206
194
-
6. Push your topic branch up to your fork:
207
+
8. Commit your changes, but **do not push compiled CSS and JS files in `dist` and `js/dist`**.
208
+
Push your topic branch up to your fork:
195
209
196
210
```bash
197
211
git push origin <topic-branch-name>
198
212
```
199
213
200
-
7.[Open a Pull Request](https://help.github.com/articles/about-pull-requests/)
201
-
with a clear title and description against the `main` branch.
214
+
9.[Open a pull request](https://help.github.com/articles/about-pull-requests/)
215
+
with a clear title and description against the `main` branch.
202
216
203
217
**IMPORTANT**: By submitting a patch, you agree to allow the project owners to
204
218
license your work under the terms of the [MIT License](../LICENSE) (if it
@@ -214,15 +228,15 @@ includes code changes) and under the terms of the
214
228
[Adhere to the Code Guide.](https://codeguide.co/#html)
215
229
216
230
- Use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags).
217
-
- 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://`.
231
+
- 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://`.
218
232
- Use [WAI-ARIA](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) attributes in documentation examples to promote accessibility.
219
233
220
234
### CSS
221
235
222
236
[Adhere to the Code Guide.](https://codeguide.co/#css)
223
237
224
238
- When feasible, default color palettes should comply with [WCAG color contrast guidelines](https://www.w3.org/TR/WCAG/#distinguishable).
225
-
- 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.
239
+
- 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.
226
240
227
241
### JS
228
242
@@ -241,4 +255,4 @@ Run `npm run test` before committing to ensure your changes follow our coding st
241
255
By contributing your code, you agree to license your contribution under the [MIT License](../LICENSE).
242
256
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/).
243
257
244
-
Prior to v3.1.0, Bootstrap's code was released under the Apache License v2.0.
258
+
Prior to v3.1.0, Bootstrap’s code was released under the Apache License v2.0.
0 commit comments