Skip to content

Commit d9b191b

Browse files
committed
docs: add a warning to Hardhat utils indicating it is internal
The `hardhat-utils` package is internal to Hardhat. It can be used from external plugins, but we do not commit to keeping major versions of utils inline with Hardhat. Put another way, if we need to make breaking changes to the util APIs for a patch update of Hardhat, we will.
1 parent a3d397d commit d9b191b

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

v-next/hardhat-utils/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Hardhat utils
22

3+
> **Warning:** This package is **internal** to Hardhat, its **API is considered internal** and may change without notice i.e. we may push breaking changes in a `hardhat-utils` major version bump to support a patch change in Hardhat.
4+
35
This package contains utilities used by Hardhat 3 and its plugins.
46

57
This package is internal to Hardhat and should not be used directly.

0 commit comments

Comments
 (0)