Skip to content

[Contracts] contracts/stream_contract/test_snapshots directory has no README explaining what the snapshot files represent or how to regenerate them #1108

Description

@grantfox-oss

Join our community: https://t.me/+DOylgFv1jyJlNzM0

Why this matters

contracts/stream_contract/test_snapshots/ is tracked in git (per the .gitignore mismatch already flagged separately) but there's no explanation anywhere of what these snapshot files are for, when they're regenerated, or what a contributor should do if their local test run produces a diff against a committed snapshot. This is the kind of tooling detail that blocks a first-time contributor's PR when their cargo test output unexpectedly differs.

Acceptance criteria

  • Add a short doc (README in the snapshots directory or a section in contracts/stream_contract/README.md) explaining snapshot purpose and regeneration command
  • Document what to do when a snapshot diff appears in a PR (regenerate vs. investigate a real behavior change)

Files to touch

  • contracts/stream_contract/test_snapshots/
  • contracts/stream_contract/README.md

Out of scope

  • Fixing the .gitignore mismatch (tracked separately)
  • Changing the snapshot testing framework

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programcontractsSmart contract related tasksdocsDocumentationgood first issueGood for newcomers

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions