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
+19-19Lines changed: 19 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Contributing to Boosted
2
2
3
-
Looking to contribute something to Boosted? **Here's how you can help.**
3
+
Looking to contribute something to Boosted? **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.
@@ -25,20 +25,20 @@ restrictions:
25
25
respect the opinions of others.
26
26
27
27
- Please **do not** post comments consisting solely of "+1" or ":thumbsup:".
28
-
Use [GitHub's "reactions" feature](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/)
28
+
Use [GitHub’s "reactions" feature](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/)
29
29
instead. We reserve the right to delete comments which violate this rule.
30
30
31
31
## Issues assignment
32
32
33
-
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.
33
+
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.
34
34
35
-
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.
35
+
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.
36
36
37
37
## Issues and labels
38
38
39
-
Our bug tracker utilizes several labels to help organize and identify issues. Here's what they represent and how we use them:
39
+
Our bug tracker utilizes several labels to help organize and identify issues. Here’s what they represent and how we use them:
40
40
41
-
-`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
+
-`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.
42
42
-`confirmed` - Issues that have been confirmed with a reduced test case and identify a bug in Boosted.
43
43
-`css` - Issues stemming from our compiled CSS or source Sass files.
44
44
-`docs` - Issues for improving or updating our documentation.
@@ -60,7 +60,7 @@ Good bug reports are extremely helpful, so thanks!
60
60
Guidelines for bug reports:
61
61
62
62
0.**[Validate your HTML](https://html5.validator.nu/)** to ensure your
63
-
problem isn't caused by a simple error in your own code.
63
+
problem isn’t caused by a simple error in your own code.
64
64
65
65
1.**Use the GitHub issue search**— check if the issue has already been
66
66
reported.
@@ -73,7 +73,7 @@ Guidelines for bug reports:
73
73
These [v4 CodePen](https://codepen.io/team/bootstrap/pen/yLabNQL) and [v5 CodePen](https://codepen.io/team/bootstrap/pen/qBamdLj) are helpful templates.
74
74
75
75
76
-
A good bug report shouldn't leave others needing to chase you up for more
76
+
A good bug report shouldn’t leave others needing to chase you up for more
77
77
information. Please try to be as detailed as possible in your report. What is
78
78
your environment? What steps will reproduce the issue? What browser(s) and OS
79
79
experience the problem? Do other browsers show the bug differently? What
@@ -105,16 +105,16 @@ Sometimes bugs reported to us are actually caused by bugs in the browser(s) them
Similarly, when contributing to Boosted's documentation, you should edit the
143
+
Similarly, when contributing to Boosted’s documentation, you should edit the
144
144
documentation source files in
145
-
[the `/boosted/site/content/docs/` directory of the `main` branch](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/tree/main/site/content/docs).
145
+
[the `/boosted/site/src/content/docs/` directory of the `main` branch](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/tree/main/site/src/content/docs).
146
146
**Do not edit the `gh-pages` branch.** That branch is generated from the
147
147
documentation source files and is managed separately by the Boosted Core Team.
148
148
@@ -183,7 +183,7 @@ included in the project:
183
183
184
184
5. Commit your changes in logical chunks. Please adhere to these [git commit
feature to tidy up your commits before making them public.
189
189
@@ -224,15 +224,15 @@ includes code changes) and under the terms of the
224
224
[Adhere to the Code Guide.](https://codeguide.co/#html)
225
225
226
226
- Use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags).
227
-
- 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://`.
227
+
- 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://`.
228
228
- Use [WAI-ARIA](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) attributes in documentation examples to promote accessibility.
229
229
230
230
### CSS
231
231
232
232
[Adhere to the Code Guide.](https://codeguide.co/#css)
233
233
234
234
- When feasible, default color palettes should comply with [WCAG color contrast guidelines](https://www.w3.org/TR/WCAG/#distinguishable).
235
-
- 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.
235
+
- 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.
236
236
237
237
### JS
238
238
@@ -251,5 +251,5 @@ Run `npm run test` before committing to ensure your changes follow our coding st
251
251
By contributing your code, you agree to license your contribution under the [MIT License](../LICENSE).
252
252
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/).
253
253
254
-
Prior to v3.1.0, Bootstrap's code was released under the Apache License v2.0.
254
+
Prior to v3.1.0, Bootstrap’s code was released under the Apache License v2.0.
255
255
However there is no prior version to v3.1.0 for Boosted.
- [ ] `npm run release` to compile dist, build Storybook, update SRI hashes in doc, and package the release
109
109
- [ ] Prepare changelog:
@@ -117,21 +117,21 @@ _Note: Please transform `- [ ]` into `- (NA)` in the description when things are
117
117
- [ ] Tag your version, and push your tag
118
118
- [ ] Pack and publish
119
119
- `npm pack`
120
-
- if you are already logged in to NPM (with a personal account, for example), [you'd better use a repository scoped `.npmrc` file](https://stackoverflow.com/questions/30114166/how-to-have-multiple-npm-users-set-up-locally)
120
+
- if you are already logged in to NPM (with a personal account, for example), [you’d better use a repository scoped `.npmrc` file](https://stackoverflow.com/questions/30114166/how-to-have-multiple-npm-users-set-up-locally)
121
121
- Publish:
122
-
- if you're releasing a pre-release, use `--tag`, e.g. for v5-alpha1 `npm publish boosted-5.0.0-alpha1.tgz --tag next`
122
+
- if you’re releasing a pre-release, use `--tag`, e.g. for v5-alpha1 `npm publish boosted-5.0.0-alpha1.tgz --tag next`
123
123
- (v4 only) `npm publish --tag v4.x.y` (if you forgot and v4 becomes the latest version on NPM, you can run `npm dist-tag add [email protected] latest to fix it)
124
124
- (v5 only) `npm publish`
125
125
- [ ] check release on [NPM](https://www.npmjs.com/package/boosted), [Nuget](https://www.nuget.org/packages/boosted/), [Packagist](https://packagist.org/packages/orange-opensource/orange-boosted-bootstrap)…
126
126
- [ ] publish documentation on `gh-pages`:
127
-
- [ ] copy `../_site` to the `gh-pages` branch (don't forget to update Storybook as well)
127
+
- [ ] copy `../_site` to the `gh-pages` branch (don’t forget to update Storybook as well)
128
128
- [ ] check every `index.html` used as redirections to redirect to the new release
129
-
- [ ] when bumping minor version: ensure `dist` URLs in examples' HTML has changed
129
+
- [ ] when bumping minor version: ensure `dist` URLs in examples’ HTML has changed
130
130
- [ ] double-check everything before pushing, starting by searching for forgotten old version number occurrences
131
131
- [ ] make an announcement in [GitHub Discussions](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/discussions/categories/announcements) (+ pin the new GH Discussion)
132
132
- [ ] [create a GitHub release](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/releases/new):
133
133
- attach the zip file
134
-
- paste the CHANGELOG / Ship list in the release's description
134
+
- paste the CHANGELOG / Ship list in the release’s description
135
135
- [ ] make an announcement on internal communication channels :tada:
136
136
- [ ] [publish on Nuget](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/wiki/Generate-NuGet-packages)
0 commit comments