Skip to content

docs: refine contract upgrade guide with explicit strategy and rollback procedures#340

Open
najeebullahii wants to merge 1 commit into
Core-Foundry:mainfrom
najeebullahii:docs/contract-upgrade-guide
Open

docs: refine contract upgrade guide with explicit strategy and rollback procedures#340
najeebullahii wants to merge 1 commit into
Core-Foundry:mainfrom
najeebullahii:docs/contract-upgrade-guide

Conversation

@najeebullahii

Copy link
Copy Markdown

Closes #310

Overview

This PR addresses Issue #310 by refining the existing CONTRACT_UPGRADE_GUIDE.md to use straightforward, action-oriented, and contributor-friendly language.

What's Changed

The documentation has been updated to explicitly cover the four required core areas:

  • Upgrade Strategy: Clear, direct guidelines on preserving state and interface safety.
  • Deployment Sequence: A practical, sequential checklist for local builds, testnet staging, and verification.
  • Common Risks: Highlighted major smart contract pitfalls including storage collisions and authorization failures.
  • Rollback Recommendations: Added structured procedures to safely recover from live upgrade failures or regressions.

Verification

  • Reviewed file structure and content layout to ensure self-contained readability for any incoming repository contributor.

@drips-wave

drips-wave Bot commented Jun 27, 2026

Copy link
Copy Markdown

@najeebullahii Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Write Smart Contract Upgrade Guide

1 participant