@texastribune/queso-ui - npm Package Compare versions

Comparing version 1.2.0-1 to 2.0.0-0

package.json

 {
   "name": "@texastribune/queso-ui",
-  "version": "1.2.0-1",
+  "version": "2.0.0-0",
   "description": "Asset library of SCSS and SVG files",
@@ -5,0 +5,0 @@ "scripts": {

README.md

@@ -125,4 +125,22 @@ # @texastribune/queso-ui
 
+### Semantic versioning
+The npm helper we use for versioning simplifies matching version numbers with the various `MAJOR`, `MINOR`, `PATCH` increment types. For guidance on what type of release you're making, refer to [https://semver.org/](https://semver.org/)
 
+Generally, you could base your increment type on the following list:
 
+- MAJOR version = CSS changes that visually break layouts where `queso-ui` is used on production
+- MINOR version = CSS changes that have no visual effect on production
+- PATCH version = CSS changes that fix a previous bug introduced on production or in development 
+
+### Steps to test breaking changes:
+1. Publish these changes on npm: `npm run release`. Copy the version number.
+2. Create a new branch in the repo in question.
+3. `yarn add @texastribune/queso-ui@VERSION`
+4. Compile the CSS
+5. Scan the various places where queso-ui is used. At the time of writing, the following pages heavily rely upon this CSS so be sure to check those if you're deprecating/changing classes.
+* [ ] [/podcasts](http://local.texastribune.org:8000/podcasts)
+* [ ] [/support-us/donors-and-members](http://local.texastribune.org:8000/support-us/donors-and-members)
+* [ ] [/newsletters/slug](http://local.texastribune.org:8000/newsletters/tribweek)
+
+
 ##  Features/Wishlist
@@ -129,0 +147,0 @@

No alert changes

Improved metrics

Total package byte prevSize

230657

increased by0.67%

Number of lines in readme file

160

increased by12.68%

No dependency changes