doc: note that tests should include a description - #9415
Merged
gibfahn merged 2 commits intoNov 5, 2016
Merged
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
thefourtheye
reviewed
Nov 2, 2016
Comment thread
doc/guides/writing_tests.md
Outdated
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Which test is this? We should recommend assert.strictEqual I guess.
Sorry, something went wrong.
Copy link
Copy Markdown
Member
Author
There was a problem hiding this comment.
@thefourtheye Done
Sorry, something went wrong.
santigimeno
approved these changes
Nov 2, 2016
gibfahn
force-pushed
the
pr-document-tests
branch
from
8a03e45 to
dbcdaaf
Compare
November 2, 2016 17:33
gibfahn
force-pushed
the
pr-document-tests
branch
from
d0655d8 to
506756a
Compare
November 2, 2016 17:42
thefourtheye
reviewed
Nov 2, 2016
Comment thread
doc/guides/writing_tests.md
Outdated
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
I think we should still align the code part perfectly.
Sorry, something went wrong.
Trott
approved these changes
Nov 2, 2016
Trott
left a comment
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
LGTM.
I agree with @thefourtheye that if we can align the code (probably just add an extra space at the start of lines 1-9?), that would be preferable.
Sorry, something went wrong.
cjihrig
approved these changes
Nov 2, 2016
cjihrig
left a comment
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
LGTM, but I don't think we should make this a hard requirement.
Sorry, something went wrong.
gibfahn
force-pushed
the
pr-document-tests
branch
from
506756a to
21a52b0
Compare
November 3, 2016 14:41
jasnell
approved these changes
Nov 3, 2016
Copy link
Copy Markdown
Member
Author
|
@Trott @thefourtheye This should be fixed @cjihrig Agreed. |
Sorry, something went wrong.
thefourtheye
approved these changes
Nov 5, 2016
Update the Writing Tests guide to specify that tests should include a brief description of what they are designed to test. PR-URL: nodejs#9415 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>oc
PR-URL: nodejs#9415 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
gibfahn
force-pushed
the
pr-document-tests
branch
from
21a52b0 to
a99b441
Compare
November 5, 2016 13:09
Copy link
Copy Markdown
Member
Author
|
Merged in: 3e6cc60...a99b441 |
Sorry, something went wrong.
evanlucas
pushed a commit
that referenced
this pull request
Nov 7, 2016
Update the Writing Tests guide to specify that tests should include a brief description of what they are designed to test. PR-URL: #9415 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>oc
evanlucas
pushed a commit
that referenced
this pull request
Nov 7, 2016
PR-URL: #9415 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Nov 22, 2016
Update the Writing Tests guide to specify that tests should include a brief description of what they are designed to test. PR-URL: #9415 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>oc
MylesBorins
pushed a commit
that referenced
this pull request
Nov 22, 2016
PR-URL: #9415 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Merged
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
9 participants
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.
Checklist
Affected core subsystem(s)
doc, test
Description of change
When debugging tests it is a huge help to have some basic information about what the purpose of the test actually is, especially as the person who originally wrote the test may no longer be active. This updates the Writing Tests guide to require that.
It's unlikely that anyone is going to have the time or the inclination to go through every test adding documentation, but specifying that we'd like some would be a good start.
Nits/bikeshedding/flat-out disagreement welcome!
cc/ @nodejs/testing