From 6ab146e65a6d3ba17b5e14ec84100b19fb936226 Mon Sep 17 00:00:00 2001 From: leojay Date: Wed, 29 Jul 2026 11:14:03 +0100 Subject: [PATCH] docs: update implementation summaries for S003 and S012 with modified behavior and rule documentation --- S003_IMPLEMENTATION_SUMMARY.md | 16 +++++++++------- S012_IMPLEMENTATION_COMPLETE.md | 12 +++++++----- 2 files changed, 16 insertions(+), 12 deletions(-) diff --git a/S003_IMPLEMENTATION_SUMMARY.md b/S003_IMPLEMENTATION_SUMMARY.md index 3413f713..e7def620 100644 --- a/S003_IMPLEMENTATION_SUMMARY.md +++ b/S003_IMPLEMENTATION_SUMMARY.md @@ -353,13 +353,6 @@ FindingCode { 3. Update `docs/rules/s003-arithmetic-overflow.md` 4. Add fixture example to `s003_arithmetic.rs` -### Modifying Behavior - -1. Update unit tests to reflect new behavior -2. Regenerate SARIF snapshots: `cargo insta review` -3. Update integration tests in `lib.rs` -4. Document change in `docs/rules/s003-arithmetic-overflow.md` Changelog -5. Consider schema versioning if JSON format changes ### Testing Checklist @@ -369,6 +362,15 @@ FindingCode { - [ ] SARIF snapshot matches: `cargo insta test` - [ ] Documentation updated: Review `docs/rules/s003-arithmetic-overflow.md` +### Modifying Behavior + +1. Update unit tests to reflect new behavior +2. Regenerate SARIF snapshots: `cargo insta review` +3. Update integration tests in `lib.rs` +4. Document change in `docs/rules/s003-arithmetic-overflow.md` Changelog +5. Consider schema versioning if JSON format changes + + ## Related Work ### Cross-References diff --git a/S012_IMPLEMENTATION_COMPLETE.md b/S012_IMPLEMENTATION_COMPLETE.md index 2dc25f19..ab6a4099 100644 --- a/S012_IMPLEMENTATION_COMPLETE.md +++ b/S012_IMPLEMENTATION_COMPLETE.md @@ -33,17 +33,19 @@ Successfully hardened the S012 (SEP-41 token interface compliance) checker in `t - Usage examples and safety considerations - Clear contribution guidelines -**Rule Documentation:** -- Complete rule guide at `docs/rules/s012-sep41-interface.md` (431 lines) -- Examples for all three issue types -- Remediation guidance and reference implementations -- Cross-references to related checks + **Reference Implementation:** - Production-ready example at `examples/sep41-compliant-token.rs` (317 lines) - Demonstrates all 10 SEP-41 functions correctly - Extensive inline comments explaining compliance +**Rule Documentation:** +- Complete rule guide at `docs/rules/s012-sep41-interface.md` (431 lines) +- Examples for all three issue types +- Remediation guidance and reference implementations +- Cross-references to related checks + ### ✅ Tests Added (Unit + Integration) **Unit Tests** (existing):