Skip to content

Commit

Permalink
docs: add note about semver and breaking changes (#372)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
lukekarrys committed Nov 6, 2023
1 parent 3e1792c commit 2a8d79e
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Expand Up @@ -3,7 +3,11 @@
This module bundles the npm CLI team's basics for package development into a
single devDependency.

**CAUTION: THESE CHANGES WILL OVERWRITE LOCAL FILES AND SETTINGS**
> [!WARNING]
> THESE CHANGES WILL OVERWRITE LOCAL FILES AND SETTINGS
> [!IMPORTANT]
> 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.
### Configuration

Expand Down

0 comments on commit 2a8d79e

Please sign in to comment.