Skip to content

Commit 85eab8c

Browse files
bmishddzz
andauthored
Describe motivation in README (#192)
* docs: describe motivation in README * Update README.md Co-authored-by: Darius Dzien <[email protected]> * tweaks * tweaks again * Update README.md Co-authored-by: Darius Dzien <[email protected]> * tweaks Co-authored-by: Darius Dzien <[email protected]>
1 parent 4a8fa26 commit 85eab8c

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@
55

66
This plugin checks to ensure that dependencies are on consistent versions across a monorepo / yarn workspace. For example, every package in a workspace that has a dependency on `eslint` should specify the same version for it.
77

8+
## Motivation
9+
10+
* **Supports a uniform developer experience.** Like shared code formatting standards, consistent dependency versions reduce friction and make it easier for developers to jump around and work across packages in a monorepo.
11+
* **Discourages piecemeal upgrades.** When possible, a dependency should be upgraded everywhere it exists in a monorepo at the same time. Upgrades are also simpler and easier to perform when fewer versions are present.
12+
* **Reduces unexpected behavior.** Having old versions present can lead to confusion, e.g., a bug present in some parts of a monorepo but not others, or uncertainty about which version wins out when served to the browser.
13+
* **Cuts down on bundle size.** Avoid serving excess dependency code to the browser.
14+
* **Saves disk space and installation time.** Faster local development and CI.
15+
816
## Usage
917

1018
To install:

0 commit comments

Comments
 (0)