Update README.md #1747
Closed
Update README.md #1747
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
SleeplessByte
approved these changes
Dec 18, 2020
|
Been doing this so 🤷🏽♂️ 😄 |
iHiD
reviewed
Dec 18, 2020
| @@ -39,7 +39,8 @@ Test data can be incorporated into a track's test suites manually or extracted b | |||
| - Exercises _must_ contain tests that cover the public interface of the exercise (also thought of as "application tests"). | |||
| - Exercises _may_ contain tests that cover the private or lower-level interface of the exercise (sometimes refered to as "library tests"). | |||
|
|
|||
| - Test cases are immutable, which means that once a test case has been added, it never changes. There are two exceptions: | |||
| - Test cases are immutable, which means that once a test case has been added, it never changes. There are a couple of exceptions: | |||
| - The `description` field _can_ be mutated and thus does not require adding a new test case when changing its value. | |||
There was a problem hiding this comment.
Suggested change
| - The `description` field _can_ be mutated and thus does not require adding a new test case when changing its value. | |
| - The `description` field _can_ be mutated to fix clarify the test or fix typos, in which case it does not require adding a new test case when changing its value. If the material meaning of the description changes, a new test is required. |
There was a problem hiding this comment.
I'd rather not add this, as I feel it is vague enough to potentially lead to interpretation issues. There is also not much risk involved in renaming a description for the following reasons:
- Each PR requires three people to approve before it can be merged. This significantly decreases the chance of weird things being merged.
- Tracks can now use the
uuidproperty to identify a test case. In fact, allowing the description to be changed might discourage tracks from doing so :)
So I'd like to merge this as is. If it turns out this leads to any problematic situations, we can always make the rule more strict.
SaschaMann
approved these changes
Dec 18, 2020
|
I think this change was already merged to However, the merged change does not fix the part that says "There are two exceptions". |
ErikSchierboom
force-pushed
the
ErikSchierboom-patch-1-1
branch
from
39baa8e to
8583028
Compare
|
This can be closed |
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.
No description provided.