Skip to content

Commit 2a8d79e

Browse files
authored
docs: add note about semver and breaking changes (#372)
This has always been true for this package, but we haven't made too many API breaking changes. Recently #362 landed which is a breaking change, since the API includes shadowing and using these files as partials. So it is best to embrace these types of changes and document the behavior.
1 parent 3e1792c commit 2a8d79e

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@
33
This module bundles the npm CLI team's basics for package development into a
44
single devDependency.
55

6-
**CAUTION: THESE CHANGES WILL OVERWRITE LOCAL FILES AND SETTINGS**
6+
> [!WARNING]
7+
> THESE CHANGES WILL OVERWRITE LOCAL FILES AND SETTINGS
8+
9+
> [!IMPORTANT]
10+
> This package does not follow semantic versioning for its API. This package is designed to be installed with `--save-exact` and therefore will make breaking API changes outside of major versions, including `engines` narrowing. Major versions are reserved for breaking changes to files written to a repo by this package.
711
812
### Configuration
913

0 commit comments

Comments
 (0)