@uob-web-and-digital/component-library 0.0.23 → 0.0.25
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 +10 -0
- package/dist/main.css +1 -1
- package/dist/main.js +5 -5
- package/dist/module.js +5 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -66,6 +66,16 @@ The visible Storybook for sharing changes is private and is accessed at [https:/
|
|
|
66
66
|
|
|
67
67
|
This is automatically deployed and built when changes are pushed to the `develop` branch of the GitHub repository.
|
|
68
68
|
|
|
69
|
+
## Linting Before Committing
|
|
70
|
+
|
|
71
|
+
Before pushing a new commit to this component-library, please ensure that you run the following ES Lint command in your terminal:
|
|
72
|
+
|
|
73
|
+
`npm run lint`
|
|
74
|
+
|
|
75
|
+
This will highlight any linting issues that may arise when making file changes that will need to be fixed.
|
|
76
|
+
|
|
77
|
+
To adhere to the commit message best practice commitlint is used. More information on commit message linting can be found here at [https://github.com/conventional-changelog/commitlint/#what-is-commitlint](https://github.com/conventional-changelog/commitlint/#what-is-commitlint)
|
|
78
|
+
|
|
69
79
|
## Publishing changes to the NPMJS package library
|
|
70
80
|
|
|
71
81
|
The repository will need publishing to the NPMJS package library [https://www.npmjs.com/package/@uob-web-and-digital/component-library](https://www.npmjs.com/package/@uob-web-and-digital/component-library) before it can be used in the UoB website.
|