Skip to content

Commit 0c05d80

Browse files
author
bbkenny
committed
chore: strictly ignore test_snapshots and add contributor policy
1 parent c90dfbb commit 0c05d80

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

docs/TEST_SNAPSHOTS_POLICY.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Test Snapshots Policy
2+
3+
**CRITICAL RULE FOR ALL CONTRIBUTORS:**
4+
5+
The `test_snapshots/` directory is strictly ignored by git and **MUST NEVER** be pushed to the repository.
6+
7+
### Why?
8+
When running tests in Rust/Soroban, the framework often generates local test snapshot files (JSON). These snapshots contain local, environment-specific state or extremely verbose output that causes massive, unnecessary PR diffs (sometimes thousands of lines long).
9+
10+
### Contributor Guidelines
11+
1. Do not forcefully add test snapshots using `git add -f`.
12+
2. Always ensure your `.gitignore` is properly ignoring `test_snapshots/`.
13+
3. Review your PR diffs carefully. If you see `.json` snapshot files in your PR, remove them before requesting a review.

0 commit comments

Comments
 (0)