Chapter 8 testing: Mark what needs or doesn't need testing #2475
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.
First pass for issue #2466.
If a section doesn't need a test, this PR explicitly marks is as "test-not-needed" (even if its an informative section). This makes it clear that we have looked at the section and made a conscious decision.
If a section talks about something that needs a test, but the actual thing (e.g. algorithm) is described in more detail elsewhere, I marked it as "test-not-needed" and added an HTML comment explaining that test coverage is elsewhere.
For steps that needs tests I've added the "needs-test" label. In many places I've added HTML TODO-comments for a second pass to verify that tests exists for specific behaviors. I'm trying to have the testing labels refer to specific testable behaviors wherever possible (rather than catch-all "this method needs a test" type of labels).
In the second pass, I will remove the TODOs and add references to the tests or change the TODO into a comment referencing the wpt issue for adding the test.
Preview | Diff