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
The Carbon Design System is a series of individual styles and components, that when combined make beautiful, intuitive designs. These designs are systemic and logical, as they all follow the same universal principles.
4
4
5
-
##### Component library for building Bluemix
5
+
The component library gives developers a collection of re-usable HTML and SCSS partials for building their products.
6
6
7
-
> Browse component library on our [Design System](http://design-system.stage1.mybluemix.net/) website.
7
+
# How to install
8
8
9
-
- Bluemix Components gives developers (FEDs & Engineers) a collection of re-usable HTML and Sass partials they can use for building websites and user-interfaces for Bluemix.
9
+
Using npm,
10
10
11
-
- The aim is for every developer to use consistent markup, styles, and behavior in their prototype and production work.
11
+
```
12
+
npm install -S carbon-components
13
+
```
12
14
13
-
##:books: Documentation
15
+
# :books: Documentation
14
16
15
-
*[Install](https://github.ibm.com/Bluemix/bluemix-components/blob/master/docs/getting-started/install.md): How to install bluemix-components
16
-
*[Update](https://github.ibm.com/Bluemix/bluemix-components/blob/master/docs/getting-started/update.md): Info for updating bluemix-components
17
-
*[Styles](https://github.ibm.com/Bluemix/bluemix-components/tree/master/docs/styles): How to use styles from bluemix-components
18
-
-[Using SCSS with Gulp](https://github.ibm.com/Bluemix/bluemix-components/tree/master/docs/styles/gulp): Tutorial for setting up a project that compiles SCSS from bluemix-components using gulp
19
-
*[Contributing](https://github.ibm.com/Bluemix/bluemix-components/blob/master/docs/contributing.md): Guidelines for making contributions to this repo.
20
-
*[Core Team](https://github.ibm.com/Bluemix/bluemix-components/blob/master/docs/core-team.md): Guidelines for repo maintainers (Bluemix Design System Team).
21
-
*[FAQ](https://github.ibm.com/Bluemix/bluemix-components/blob/master/docs/getting-started/faq.md): Solutions for common errors and answers to common questions
17
+
* See our documentation site [here](http://carbondesignsystem.com/getting-started/developers) for full how-to docs and guidelines
18
+
*[Contributing](blob/master/docs/contributing.md): Guidelines for making contributions to this repo.
The a11y test may report potential issues that should be handled in application-level, not in bluemix-components code. In such case, you can ignore those issues by adding an item to `shouldIssueBeIgnoredForRule` table in [tests/a11y/global-ignore-aat-issues.js](https://github.ibm.com/Bluemix/bluemix-components/blob/master/tests/a11y/global-ignore-aat-issues.js). The table is keyed by something like `wcag20.tech.h59.linkValid` which helps indentifying what RPT rule to ignore. You can specify `true` to the value which ignores all violations of the rule, or a function which takes the DOM element violating the rule and returns `true` if such violation should be ignored.
203
+
The a11y test may report potential issues that should be handled in application-level, not in bluemix-components code. In such case, you can ignore those issues by adding an item to `shouldIssueBeIgnoredForRule` table in [tests/a11y/global-ignore-aat-issues.js](https://github.com/carbon-design-system/carbon-components/blob/master/tests/a11y/global-ignore-aat-issues.js). The table is keyed by something like `wcag20.tech.h59.linkValid` which helps indentifying what RPT rule to ignore. You can specify `true` to the value which ignores all violations of the rule, or a function which takes the DOM element violating the rule and returns `true` if such violation should be ignored.
215
204
216
205
## 7. Make a Pull Request
217
206
218
-
**Note:** Before you make a pull request, [search](https://github.ibm.com/Bluemix/bluemix-components/issues) the issues to see if a similar issue has already been submitted. If a similar issue has been submitted, assign yourself or ask to be assigned to the issue by posting a comment. If the issue does not exist, create a new issue.
207
+
**Note:** Before you make a pull request, [search](https://github.com/carbon-design-system/carbon-components/issues) the issues to see if a similar issue has already been submitted. If a similar issue has been submitted, assign yourself or ask to be assigned to the issue by posting a comment. If the issue does not exist, create a new issue.
219
208
220
209
When you're at a good stopping place and you're ready for feedback from other contributors and maintainers, **push your commits to your fork**:
221
210
222
211
```
223
212
git push origin { YOUR_BRANCH_NAME }
224
213
```
225
214
226
-
In your browser, navigate to [Bluemix/bluemix-components](https://github.ibm.com/Bluemix/bluemix-components) and click the button that reads "Compare & pull request"
In your browser, navigate to [Bluemix/bluemix-components](https://github.com/carbon-design-system/carbon-components) and click the button that reads "Compare & pull request"
229
216
230
217
> **Is it a Breaking Change?**
231
218
@@ -246,14 +233,10 @@ Before you create a pull request, change the base branch depending on what kind
246
233
* Pull requests with **non-breaking changes** like patches and minor updates use the `master` as the base branch.
247
234
* Pull requests with **breaking changes** use the latest `major version number` branch as the base branch (i.e. `7.0.0` or whatever the next major version is).
*[How to write the perfect pull request](https://github.com/blog/1943-how-to-write-the-perfect-pull-request)
255
239
256
-
257
240
## 8. Updating a Pull Request
258
241
259
242
Stay up to date with the activity in your pull request. Maintainers from the Design System team will be reviewing your work and making comments, asking questions and suggesting changes to be made before they merge your code.
@@ -262,6 +245,4 @@ Stay up to date with the activity in your pull request. Maintainers from the Des
262
245
263
246
When you need to make a change, add, commit and push to your branch normally.
264
247
265
-
Once all revisiions to your pull request are complete, someone from Design Systems will squash and merge your commits for you.
266
-
267
-
248
+
Once all revisiions to your pull request are complete, someone from Design Systems will squash and merge your commits for you.
0 commit comments