Add design docs for before-and-after report, quality gate, compilation validator, and test runner - #852
Merged
mijinummi merged 1 commit intoAug 28, 2026
Conversation
|
@michaelsimeon001 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! 🚀 |
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds design/spec docs for the Soroban optimization pipeline, following this repo's existing convention of documenting features under docs/ (e.g. docs/IMPLEMENTATION_SUMMARY.md).
Closes #821
Adds a before-and-after comparison report design (docs/issue-821-before-and-after-report.md) covering changed findings, resource deltas, applied optimizations, and remaining issues for packages/reporting/soroban/comparison.
Closes #822
Adds a quality gate design (docs/issue-822-optimization-quality-gate.md) that validates resource improvement, regressions, compilation status, and security findings before an optimization is accepted, for packages/quality-gates/soroban.
Closes #823
Adds a compilation validator design (docs/issue-823-optimization-compilation-validator.md) that compiles optimized Rust contracts, captures diagnostics, and rejects failed transformations, for packages/autofix/validation/compile.
Closes #824
Adds a test runner design (docs/issue-824-optimization-test-runner.md) that executes contract tests after optimization and compares results against a pre-optimization baseline, for packages/autofix/validation/tests.
No source files were touched; this PR only adds new markdown files under docs/.