NoBey/openzeppelin-contracts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve documentation about backwards compatibility (#4627)

Browse Source 
Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>
Co-authored-by: Ernesto García <ernestognw@gmail.com>
(cherry picked from commit 2472e51e80)
This commit is contained in:
Francisco
2023-09-28 12:54:44 -03:00
committed by Francisco Giordano
parent b805cc82d3
commit 53f2721e8c
7 changed files with 72 additions and 110 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/modules/ROOT/pages/index.adoc
View File

@ -6,6 +6,8 @@
* Flexible xref:access-control.adoc[role-based permissioning] scheme.
* Reusable xref:utilities.adoc[Solidity components] to build custom contracts and complex decentralized systems.
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 xref:backwards-compatibility.adoc[Backwards Compatibility].
== Overview
[[install]]
@ -17,8 +19,6 @@
$ npm install @openzeppelin/contracts
```
OpenZeppelin Contracts features a xref:releases-stability.adoc#api-stability[stable API], which means that your contracts won't break unexpectedly when upgrading to a newer minor version.
==== Foundry (git)
WARNING: When installing via git, it is a common error to use the `master` branch. This is a development branch that should be avoided in favor of tagged releases. The release process involves security measures that the `master` branch does not guarantee.