Add readme to ref counter #3321
Merged
Conversation
This file contains 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
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.
README
What is the ref_counter?
The ref_counter is part of reproduciability tests. The counter identifies a
particular snapshot of our code, a "reference". Each PR is tested against this
reference to check if it reproduces the expected behavior. This allows us to
check that PRs that are expected to not modify the behavior do indeed preserve
the previous behavior.
When am I allowed to increase the ref_counter?
If know that your PR is changing some behavior (e.g., you are changing
parameters, or how things are computed, or added a new component), you should
increase the number on top of this file and add an explanation on why it has
changed in the comments below. Increasing the ref_counter will make your PR
the new reference that other PRs will be compared against.