Skip to content

Commit

Permalink
Update e2e-testing.md
Browse files Browse the repository at this point in the history
Discussed the use of the term 'should' at the start of test names.  Using 'should' at the start of test names is a long standing and accepted standard.  We should be more aligned with the tools and frameworks guidelines and recommendations that we use.

Even repeated test names within a test file using 'should' at the start of test names should be considered valid.
  • Loading branch information
chrisleewilcox authored Aug 30, 2024
1 parent 49edf8e commit e6cacde
Showing 1 changed file with 1 addition and 8 deletions.
9 changes: 1 addition & 8 deletions docs/e2e-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,7 @@ The test name should communicate the purpose and behaviour of the test. A clear
- send 1 TST to Bob
```

⚠️ Test names remain approachable, recommend to avoid using the meaningless prefix 'should'

```javascript
- should add Bob to the address book
- should send 1 TST to Bob
```

❌ Test name should be completely avoided: The use of a `should` prefix and the word `and` can decrease the readability of the test,making it harder to understand what the test is doing as well as diagnose and fix issues.
❌ Test name should be completely avoided: Long test names that may over explain the test intention and the word `and` can decrease the readability of the test,making it harder to understand what the test is doing as well as diagnose and fix issues.

```javascript
- should add Bob to the address book and send 1 TST to Bob
Expand Down

0 comments on commit e6cacde

Please sign in to comment.