From e0846a6c8d6bf8c3a99e727076bcf3dcd06262f2 Mon Sep 17 00:00:00 2001 From: Boomchain Labs <202796817+BoomchainLabs@users.noreply.github.com> Date: Tue, 6 May 2025 12:31:29 +0100 Subject: [PATCH] Add note about upgradeable variant of OpenZeppelin Contracts Add a note about the upgradeable variant of OpenZeppelin Contracts in `README.md`. * Add a note indicating that the user is looking at the upgradeable variant of OpenZeppelin Contracts. * Add a link to the documentation on using OpenZeppelin Contracts with Upgrades. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/BoomchainLabs/openzeppelin-contracts-upgradeable?shareId=XXXX-XXXX-XXXX-XXXX). --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0e4f91a6d..dea1413d0 100644 --- a/README.md +++ b/README.md @@ -19,9 +19,9 @@ > [!IMPORTANT] > OpenZeppelin Contracts uses semantic versioning to communicate backwards compatibility of its API and storage layout. For upgradeable contracts, the storage layout of different major versions should be assumed incompatible, for example, it is unsafe to upgrade from 4.9.3 to 5.0.0. Learn more at [Backwards Compatibility](https://docs.openzeppelin.com/contracts/backwards-compatibility). -+> [!NOTE] -+> You are looking at the upgradeable variant of OpenZeppelin Contracts. Be sure to review the documentation on [Using OpenZeppelin Contracts with Upgrades](https://docs.openzeppelin.com/contracts/upgradeable). -+ +> [!NOTE] +> You are looking at the upgradeable variant of OpenZeppelin Contracts. Be sure to review the documentation on [Using OpenZeppelin Contracts with Upgrades](https://docs.openzeppelin.com/contracts/upgradeable). + ## Overview ### Installation