Skip to content

Commit 6ab146e

Browse files
committed
docs: update implementation summaries for S003 and S012 with modified behavior and rule documentation
1 parent 3f68b1d commit 6ab146e

2 files changed

Lines changed: 16 additions & 12 deletions

File tree

S003_IMPLEMENTATION_SUMMARY.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -353,13 +353,6 @@ FindingCode {
353353
3. Update `docs/rules/s003-arithmetic-overflow.md`
354354
4. Add fixture example to `s003_arithmetic.rs`
355355

356-
### Modifying Behavior
357-
358-
1. Update unit tests to reflect new behavior
359-
2. Regenerate SARIF snapshots: `cargo insta review`
360-
3. Update integration tests in `lib.rs`
361-
4. Document change in `docs/rules/s003-arithmetic-overflow.md` Changelog
362-
5. Consider schema versioning if JSON format changes
363356

364357
### Testing Checklist
365358

@@ -369,6 +362,15 @@ FindingCode {
369362
- [ ] SARIF snapshot matches: `cargo insta test`
370363
- [ ] Documentation updated: Review `docs/rules/s003-arithmetic-overflow.md`
371364

365+
### Modifying Behavior
366+
367+
1. Update unit tests to reflect new behavior
368+
2. Regenerate SARIF snapshots: `cargo insta review`
369+
3. Update integration tests in `lib.rs`
370+
4. Document change in `docs/rules/s003-arithmetic-overflow.md` Changelog
371+
5. Consider schema versioning if JSON format changes
372+
373+
372374
## Related Work
373375

374376
### Cross-References

S012_IMPLEMENTATION_COMPLETE.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,17 +33,19 @@ Successfully hardened the S012 (SEP-41 token interface compliance) checker in `t
3333
- Usage examples and safety considerations
3434
- Clear contribution guidelines
3535

36-
**Rule Documentation:**
37-
- Complete rule guide at `docs/rules/s012-sep41-interface.md` (431 lines)
38-
- Examples for all three issue types
39-
- Remediation guidance and reference implementations
40-
- Cross-references to related checks
36+
4137

4238
**Reference Implementation:**
4339
- Production-ready example at `examples/sep41-compliant-token.rs` (317 lines)
4440
- Demonstrates all 10 SEP-41 functions correctly
4541
- Extensive inline comments explaining compliance
4642

43+
**Rule Documentation:**
44+
- Complete rule guide at `docs/rules/s012-sep41-interface.md` (431 lines)
45+
- Examples for all three issue types
46+
- Remediation guidance and reference implementations
47+
- Cross-references to related checks
48+
4749
### ✅ Tests Added (Unit + Integration)
4850

4951
**Unit Tests** (existing):

0 commit comments

Comments
 (0)