Skip to content

Update README.md#1747

Closed
ErikSchierboom wants to merge 1 commit intomainfrom
ErikSchierboom-patch-1-1
Closed

Update README.md#1747
ErikSchierboom wants to merge 1 commit intomainfrom
ErikSchierboom-patch-1-1

Conversation

@ErikSchierboom
Copy link
Copy Markdown
Member

No description provided.

@SleeplessByte
Copy link
Copy Markdown
Member

Been doing this so 🤷🏽‍♂️ 😄

Comment thread README.md

- 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.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

  1. Each PR requires three people to approve before it can be merged. This significantly decreases the chance of weird things being merged.
  2. Tracks can now use the uuid property 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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think #1746 vs #1744 are good examples and would be caught by at least one person, I think.

Base automatically changed from master to main January 27, 2021 15:31
@angelikatyborska
Copy link
Copy Markdown
Member

I think this change was already merged to main so this PR could be closed:
https://github.com/exercism/problem-specifications/blob/main/README.md#L42-L45

However, the merged change does not fix the part that says "There are two exceptions".

@ErikSchierboom ErikSchierboom force-pushed the ErikSchierboom-patch-1-1 branch from 39baa8e to 8583028 Compare June 24, 2021 07:34
@ErikSchierboom
Copy link
Copy Markdown
Member Author

This can be closed

@petertseng petertseng deleted the ErikSchierboom-patch-1-1 branch January 30, 2022 03:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants