doc: add test naming information to guide #10584
Closed
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
Trott
added
doc
nodejs-github-bot
added
doc
gibfahn
reviewed
Jan 3, 2017
| A test must be a node script that exercises a specific functionality provided | ||
| by node and checks that it behaves as expected. It should exit with code `0` on success, | ||
| otherwise it will fail. A test will fail if: | ||
| Most tests in Node.js core are JavaScript programs that exercise a specific |
There was a problem hiding this comment.
Nit: Can you say a functionality? I feel like it should be a piece of functionality or just functionality.
gibfahn
approved these changes
Jan 3, 2017
italoacasas
approved these changes
Jan 3, 2017
cjihrig
approved these changes
Jan 3, 2017
thefourtheye
reviewed
Jan 3, 2017
| otherwise it will fail. A test will fail if: | ||
| Most tests in Node.js core are JavaScript programs that exercise a specific | ||
| functionality provided by Node.js and check that it behaves as expected. Tests | ||
| should exit with code `0` on success. A test will fail if: | ||
|
|
||
| - It exits by setting `process.exitCode` to a non-zero number. | ||
| - This is most often done by having an assertion throw an uncaught |
There was a problem hiding this comment.
more often or most often?
There was a problem hiding this comment.
I think I'll just switch to the simpler usually. :-D
jasnell
approved these changes
Jan 3, 2017
thefourtheye
suggested changes
Jan 3, 2017
| more information about what is being tested. | ||
|
|
||
| For example, a test for the `beforeExit` event on the `process` object might be | ||
| named `test-process-beforeExit.js`. If the test specifically checked that arrow |
There was a problem hiding this comment.
As per #10581 (comment), we may have to discuss this further.
The guide for writing tests is missing information on how tests are named. This adds that information. There is also some copy-editing done on the first paragraph of the guide.
|
Nits handled, including camel-casing controversy. PTAL @thefourtheye. Perhaps @sam-github can look it over too. |
sam-github
approved these changes
Jan 9, 2017
|
/ping @thefourtheye Does this look OK to you now? |
thefourtheye
approved these changes
Jan 10, 2017
jasnell
pushed a commit
that referenced
this pull request
Jan 10, 2017
The guide for writing tests is missing information on how tests are named. This adds that information. There is also some copy-editing done on the first paragraph of the guide. PR-URL: #10584 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
|
Landed in eb0df4a |
italoacasas
pushed a commit
to italoacasas/node
that referenced
this pull request
Jan 18, 2017
The guide for writing tests is missing information on how tests are named. This adds that information. There is also some copy-editing done on the first paragraph of the guide. PR-URL: nodejs#10584 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
italoacasas
pushed a commit
to italoacasas/node
that referenced
this pull request
Jan 23, 2017
The guide for writing tests is missing information on how tests are named. This adds that information. There is also some copy-editing done on the first paragraph of the guide. PR-URL: nodejs#10584 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
italoacasas
pushed a commit
to italoacasas/node
that referenced
this pull request
Jan 24, 2017
The guide for writing tests is missing information on how tests are named. This adds that information. There is also some copy-editing done on the first paragraph of the guide. PR-URL: nodejs#10584 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
italoacasas
pushed a commit
to italoacasas/node
that referenced
this pull request
Jan 27, 2017
The guide for writing tests is missing information on how tests are named. This adds that information. There is also some copy-editing done on the first paragraph of the guide. PR-URL: nodejs#10584 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Mar 7, 2017
The guide for writing tests is missing information on how tests are named. This adds that information. There is also some copy-editing done on the first paragraph of the guide. PR-URL: #10584 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Mar 7, 2017
The guide for writing tests is missing information on how tests are named. This adds that information. There is also some copy-editing done on the first paragraph of the guide. PR-URL: #10584 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Mar 9, 2017
The guide for writing tests is missing information on how tests are named. This adds that information. There is also some copy-editing done on the first paragraph of the guide. PR-URL: #10584 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Mar 9, 2017
The guide for writing tests is missing information on how tests are named. This adds that information. There is also some copy-editing done on the first paragraph of the guide. PR-URL: #10584 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Merged
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.
The guide for writing tests is missing information on how tests are
named. This adds that information.
There is also some copy-editing done on the first paragraph of the
guide.
Checklist
Affected core subsystem(s)
doc test