Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Adding where does test go section in writing-test.md #18802

Closed
wants to merge 11 commits into from
Closed

Adding where does test go section in writing-test.md #18802

Changes from 3 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
481c5f9
Adding where does test go section in writing-test.md
juggernaut451 Feb 15, 2018
dd902a0
Typo fix
juggernaut451 Feb 15, 2018
c1c8eb5
Typo fix
juggernaut451 Feb 15, 2018
5bf8d98
reframing content and topic of section
juggernaut451 Feb 15, 2018
ca0448b
Fixes: https://github.com/nodejs/node/issues/18774
juggernaut451 Feb 17, 2018
2dea00a
Restructuring the description
juggernaut451 Feb 19, 2018
ba6513b
Wrapping line in 80 characters
juggernaut451 Feb 21, 2018
b24c938
Typo fixes
juggernaut451 Feb 22, 2018
0fa4c3a
refactoring content
juggernaut451 Mar 1, 2018
c8696df
wrapping in 80 char
juggernaut451 Mar 2, 2018
fc0c5b4
doc: adding test directory structure
juggernaut451 Mar 7, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions doc/guides/writing-tests.md
View file
Open in desktop
Expand Up @@ -18,6 +18,13 @@ Add tests when:
- Fixing regressions and bugs.
- Expanding test coverage.

## Where does the test go
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would sound better as "Where are tests located" (maybe "Where are the..." but that's getting clunky) or even "Test directory structure".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changing it to "Test directory structure"

One can refer [test directory structure](https://github.com/nodejs/node/tree/master/test)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

General nit: please keep lines to 80 chars. I think URLs can, maybe, be excepted.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks 👍

to decide where to put your test cases. If you want to find any current test that exists then
go to the defined [test directory structure](https://github.com/nodejs/node/tree/master/test)
and search for similar APIs and see if there is similar file available.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall, this is a bit too verbose and repeats the same information twice. We also do our best to avoid using "you", "your", "one" and similar. We could communicate the same thought in a shorter sentence:

See the test directory structure overview for an outline of existing test types and their locations.

That could probably be improved further. (Note that the link above goes directly to the README rather than the test folder.)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does above description answers #18774 second issue?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It probably doesn't but I don't think the current one does either. I would go with something like:

When deciding on whether to expand an existing test file or create a new one, consider going through the files related to the subsystem (e.g. ones starting with "test-streams" for lib/streams.js) and assessing whether a related test already exists.

It's possible that should be even more detailed, like for example explaining the difference between parallel and sequential, but that could get quite tricky and complicated.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks making changes with the above one. :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changes made.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for feedback.



Copy link
Member

Choose a reason for hiding this comment

The 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 :-)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changes made.

Copy link
Member

Choose a reason for hiding this comment

The 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:
Expand Down