diff --git a/assets/foundry-update-template.md b/assets/foundry-update-template.md new file mode 100644 index 000000000..270e6d695 --- /dev/null +++ b/assets/foundry-update-template.md @@ -0,0 +1,54 @@ +# Foundry Version Upgrade Proposal + + + +**Table of Contents** + +- [Upgrade Info](#upgrade-info) +- [Changelog Links](#changelog-links) +- [Benefits to the OP Stack](#benefits-to-the-op-stack) +- [Notable Features](#notable-features) +- [Notable Bug Fixes](#notable-bug-fixes) +- [Additional Notes](#additional-notes) + + + +_Italics are used to indicate things that need to be replaced._ + +| | | +| ------------------- | -------------------------------------------------- | +| Author | _Author Name_ | +| Created at | _YYYY-MM-DD_ | +| Needs Approval From | _Security Reviewer Name 1, Security Reviewer Name 2_ | +| Status | _Draft / In Review / Implementing Actions / Final_ | + +## Upgrade Info + +- **Current Version:** _[e.g., v1.5.0]_ +- **Proposed Version:** _[e.g., v1.6.0]_ + +## Changelog Links + +_Provide links to the Foundry changelog for each version between the current version used in the +codebase and the proposed new version._ + +## Benefits to the OP Stack + +_Explain specific feature(s) in the new version that would benefit the OP Stack codebase, with a +clear explanation of their potential impact and usefulness._ + +## Notable Features + +_Highlight any potentially notable features that require special attention during the review +process. Features should be considered "notable" if they add significant new functionality to +Foundry or required significant changes to Foundry to be supported._ + +## Notable Bug Fixes + +_Highlight any potentially notable bug fixes that require special attention during the review +process. Bug fixes should be considered "notable" if they are classified at or above a "medium" by +the Foundry team._ + +## Additional Notes + +_Any other relevant information or considerations._