New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adding where does test go section in writing-test.md #18802
Changes from 5 commits
481c5f9
dd902a0
c1c8eb5
5bf8d98
ca0448b
2dea00a
ba6513b
b24c938
0fa4c3a
c8696df
fc0c5b4
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,6 +18,15 @@ Add tests when: | |
- Fixing regressions and bugs. | ||
- Expanding test coverage. | ||
|
||
## Test directory structure | ||
See the test [directory structure overview](https://github.com/nodejs/node/blob/master/test/README.md) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adding a new line after the header would be good for consistency as well. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. changes made. |
||
for an outline of existing test types and their locations. | ||
When deciding on whether to expand an existing test file or create a new one, | ||
consider going through the files related to the subsystem. | ||
For example, take a look at tests starting with "test-streams" | ||
when writing tests for `lib/streams.js` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The line breaks in this paragraph are actually not visible when viewing this not in raw form. Therefore it would be good to wrap each line around 80 characters. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. changes made. |
||
|
||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please keep this consistent with the other places in the doc and only use a single new line :-) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. changes made. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hm, this does not seem to be addressed? |
||
## Test structure | ||
|
||
Let's analyze this basic test from the Node.js test suite: | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this is longer than 80 characters, please move the reference down to the end of the file and only keep
[directory structure overview][]
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
changes made.