@narmi/design_system 4.26.1 → 4.27.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -1
- package/dist/docs/classManifest.json +5 -0
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/style.css +3 -3
- package/dist/style.css.map +1 -1
- package/dist/tokens/css/rgbColors.css +1 -1
- package/dist/tokens/css/tokens.css +1 -1
- package/dist/tokens/js/colors.js +1 -1
- package/dist/tokens/js/manifest.js +1 -1
- package/dist/tokens/js/reactNativeWeb.js +1 -1
- package/dist/types/Chip/index.d.ts +31 -0
- package/dist/types/Chip/index.d.ts.map +1 -0
- package/dist/types/Count/index.d.ts +13 -0
- package/dist/types/Count/index.d.ts.map +1 -0
- package/dist/types/Table/Body.d.ts.map +1 -1
- package/dist/types/Table/Cell.d.ts.map +1 -1
- package/dist/types/Table/Header.d.ts.map +1 -1
- package/dist/types/Table/HeaderCell.d.ts +22 -0
- package/dist/types/Table/HeaderCell.d.ts.map +1 -0
- package/dist/types/Table/index.d.ts +1 -0
- package/dist/types/Table/index.d.ts.map +1 -1
- package/dist/types/index.d.ts +3 -1
- package/dist/types/index.d.ts.map +1 -1
- package/package.json +1 -1
- package/dist/types/Table/util/tableSectionContext.d.ts +0 -10
- package/dist/types/Table/util/tableSectionContext.d.ts.map +0 -1
package/README.md
CHANGED
|
@@ -160,6 +160,27 @@ Any modification to the design system that requires consumers to update their us
|
|
|
160
160
|
|
|
161
161
|
If you are making a breaking change, please [note it in your commit message](https://www.conventionalcommits.org/en/v1.0.0/#commit-message-with-description-and-breaking-change-footer) appropriately.
|
|
162
162
|
|
|
163
|
+
### Pull Request guide
|
|
164
|
+
|
|
165
|
+
There are a number of github actions we run automatically for every PR.
|
|
166
|
+
In order for your PR to merge it must:
|
|
167
|
+
|
|
168
|
+
- Build without failures and/or typescript errors
|
|
169
|
+
- Pass all unit tests
|
|
170
|
+
- Pass Chromatic snapshot tests
|
|
171
|
+
|
|
172
|
+
#### Working with snapshot tests
|
|
173
|
+
|
|
174
|
+
If you see a comment on your PR notifying you that visual differences were detected,
|
|
175
|
+
you must manually resolve them by either fixing your code OR accepting the change in
|
|
176
|
+
the Chromatic app if the visual diff was intentional.
|
|
177
|
+
|
|
178
|
+
You will need to log into [Chromatic]<chromatic.com> using the credentials provided in 1password.
|
|
179
|
+
Links to the snapshot review and the storybook preview build will be provided by narmibot in a PR comment.
|
|
180
|
+
|
|
181
|
+
Once all changes have been accepted and/or you are confident you've have addressed
|
|
182
|
+
regressions in your code, you must rerun the workflow.
|
|
183
|
+
|
|
163
184
|
### Testing unpublished changes in a consumer
|
|
164
185
|
|
|
165
186
|
**Development of Narmi Design System should be done in isolation within this repo.**
|
|
@@ -191,4 +212,3 @@ If you need to make additional changes after the beta is published...
|
|
|
191
212
|
## License
|
|
192
213
|
|
|
193
214
|
Source code is under a custom license based on MIT. The license restricts `@narmi/design_system` usage to applications that integrate or interoperate with Narmi software or services, with additional restrictions for external, stand-alone applications. Please see LICENSE.md for full details.
|
|
194
|
-
|