@ukic/canary-react 2.0.0-canary.31 → 2.0.0-canary.33

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.
Files changed (2) hide show
  1. package/README.md +14 -2
  2. package/package.json +7 -6
package/README.md CHANGED
@@ -16,10 +16,10 @@ To install the components:
16
16
  In the root of your project:
17
17
 
18
18
  ```shell
19
- // using npm
19
+ # using npm
20
20
  npm install @ukic/canary-react @ukic/fonts
21
21
 
22
- // using yarn
22
+ # using yarn
23
23
  rm package-lock.json
24
24
  yarn add @ukic/canary-react @ukic/fonts
25
25
  ```
@@ -57,6 +57,18 @@ The `@ukic/canary-react` package will need to be transformed before you can use
57
57
 
58
58
  Add a `transformIgnorePatterns` field with the value `["/node_modules/(?!@ukic/canary-react)"]` to your Jest config.
59
59
 
60
+ ## Contributing
61
+
62
+ We have a couple of resources to help you with contributing.
63
+
64
+ - To find out more about the different types of contributions, the criteria, raising issues or our release roadmap, read [how to contribute to the Design System and UI Kit](https://design.sis.gov.uk/community/contribute).
65
+ - Make sure to also read our [coding standards and technical instructions](https://github.com/mi6/ic-ui-kit/blob/main/CONTRIBUTING.md).
66
+ - [IC Design System guidance site repository](https://github.com/mi6/ic-design-system) contains the code and content for the Design System guidance site.
67
+ - [IC UI Kit repository](https://github.com/mi6/ic-ui-kit) contains the code and content for the web components.
68
+ ## Changelog
69
+
70
+ For a comprehensive changelog of the canary React components, please read the canary web components [CHANGELOG](https://github.com/mi6/ic-ui-kit/blob/main/packages/canary-web-components/CHANGELOG.md). The released updates made to the canary web components are reflected on the canary React components.
71
+
60
72
  ## Security
61
73
 
62
74
  If you've found a vulnerability, we want to know so that we can fix it. [Our security policy](https://github.com/mi6/ic-ui-kit/blob/main/SECURITY.md) tells you how to do this.
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "sideEffects": [
4
4
  "*.css"
5
5
  ],
6
- "version": "2.0.0-canary.31",
6
+ "version": "2.0.0-canary.33",
7
7
  "description": "React-wrapped web components compiled using StencilJS",
8
8
  "scripts": {
9
9
  "build": "npm run clean && npm run compile && npm run copy:core-css && npm run copy:normalize-css",
@@ -30,9 +30,9 @@
30
30
  "dist/"
31
31
  ],
32
32
  "dependencies": {
33
- "@ukic/canary-web-components": "^2.0.0-canary.31",
34
- "@ukic/react": "^2.32.1",
35
- "@ukic/web-components": "^2.32.1"
33
+ "@ukic/canary-web-components": "^2.0.0-canary.33",
34
+ "@ukic/react": "^2.34.0",
35
+ "@ukic/web-components": "^2.34.0"
36
36
  },
37
37
  "devDependencies": {
38
38
  "@babel/core": "^7.16.0",
@@ -60,7 +60,8 @@
60
60
  "cross-env": "^7.0.3",
61
61
  "cypress": "^13.3.1",
62
62
  "cypress-axe": "^1.5.0",
63
- "cypress-image-diff-js": "^1.32.0",
63
+ "cypress-image-diff-html-report": "^2.2.0",
64
+ "cypress-image-diff-js": "^2.1.3",
64
65
  "eslint-plugin-cypress": "^2.15.1",
65
66
  "github-markdown-css": "^5.5.0",
66
67
  "jest": "^27.4.1",
@@ -94,5 +95,5 @@
94
95
  ]
95
96
  },
96
97
  "license": "MIT",
97
- "gitHead": "f980df4943f525b9ff377a859284bec90a5725da"
98
+ "gitHead": "6933256d2e62a911545e88614bf8283471bc0331"
98
99
  }