docs: document the test snapshot commit policy - #54
Merged
Conversation
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
1 participant
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.
Summary
Adds the rule CONTRIBUTING.md's Testing philosophy section was missing: whether to commit a
test_snapshots/file comes down to reproducibility, not test type. Hand-written tests produce a stable file and should commit it;proptest_*modules produce a different file every run and should.gitignorethe module's directory instead.This has been the repo's actual practice throughout, this just writes it down.
Closes #24
Test plan
.gitignorepattern (test_snapshots/test/<module>/) matches what's actually there for both existing proptest modules