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: docs/CONTRIBUTING.md
+5-4
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,8 @@
8
8
npx husky install
9
9
```
10
10
11
+
- Install the [CSS Var Complete - VS Code Plugin](https://marketplace.visualstudio.com/items?itemName=phoenisx.cssvar) which provides better Intellisense while writing CSS and referencing CSS variables.
12
+
11
13
## Git Flow
12
14
13
15
This project uses [Git-flow](https://nvie.com/posts/a-successful-git-branching-model/) to manage the development workflow. Here's a breakdown of what this means for the design system:
@@ -42,15 +44,14 @@ A few notes about breaking changes:
42
44
- Consider writing a codemod (using [JSCodeShift](https://github.com/facebook/jscodeshift) for systematic changes.
43
45
- There may be a way to make the change in a backwards-compatible way. Consider this during implementation, providing some rationale in cases where it is not feasible/practical to do so.
44
46
45
-
46
47
## Making Edits to Tokens
47
48
48
49
### Adding new tokens
49
50
50
51
When we need to introduce new tokens to account for customizations or features in new or existing components, for each new token, we use the following process:
51
52
52
53
1. Determine the tier of the new token with design
53
-
2. Work with design to make sure the token is added to figma with the proper naming format
54
+
2. Work with design to make sure the token is added to figma with the proper naming format
54
55
55
56
For example, tokens in figma have a name in the format 'Category/token-name', so we'd want the resulting token in code to resolve to `--eds-theme-color-category-token-name`.
56
57
@@ -71,10 +72,10 @@ For example, if we had a token `--eds-theme-color-background-old-name` which we
71
72
"comment": "@deprecated This token is deprecated. Please use eds-theme-color-new-name instead."
72
73
```
73
74
74
-
This has the folling benefits:
75
+
This has the following benefits:
75
76
76
77
- Users who have added a theme value to `--eds-theme-color-background-old-name` will not have their theme value break upon update.
77
78
- Users can see which tokens are deprecated via the autogenerated comment in the token files.
78
79
- Users can adopt the new token when convenient, and EDS can publish new versions without introducing multiple breaking changes.
79
80
80
-
4. Finally, we replace all uses of the old token with the new token.
81
+
4. Finally, we replace all uses of the old token with the new token.
0 commit comments