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

test: add comments describing every test #22424

Closed
wants to merge 2 commits into from
Closed

test: add comments describing every test #22424

wants to merge 2 commits into from

Conversation

ratracegrad
Copy link
Contributor

Providing consistency in tests by adding comments to describe the test's functionality.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • commit message follows commit guidelines

@nodejs-github-bot nodejs-github-bot added the test Issues and PRs related to the tests. label Aug 21, 2018
@bcoe bcoe self-requested a review August 21, 2018 02:04
@vsemozhetbyt
Copy link
Contributor

Thank you! A tiny note: we usually try to add periods at the end of comments now.

@vsemozhetbyt
Copy link
Contributor

Also, it seems your commits are not attributed to your GitHub account now. Can you config your email setting as described here (see "Please make sure..." paragraph)?

@Trott
Copy link
Member

Trott commented Aug 21, 2018

CI: https://ci.nodejs.org/job/node-test-pull-request/16624/

@Trott
Copy link
Member

Trott commented Aug 21, 2018

Welcome, @ratracegrad, and thanks for the pull request!

addaleax
addaleax approved these changes Aug 21, 2018
View reviewed changes
Copy link
Member

@addaleax addaleax left a comment

Choose a reason for hiding this comment

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

Can you config your email setting as described here (see "Please make sure..." paragraph)?

Just to be clear: This is voluntary, and only affects whether Github attributes the commit to you or not. You don't have to do anything. :)

@Trott
Copy link
Member

Trott commented Aug 21, 2018 •
edited
Loading

The change looks good to me, but the commit message could be updated as it suggests (to me, at least) that this is adding comments to all test files rather than a single test file. This is something the person landing the PR can do, but if you want to take care of it for them, it will save someone a few keystrokes.

@Trott Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Aug 22, 2018
bcoe
bcoe approved these changes Aug 22, 2018
View reviewed changes
Copy link
Contributor

@bcoe bcoe left a comment

Choose a reason for hiding this comment

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

this looks great, once we get the test suite running. If you go ahead and address folks' comments about the commit title and missing period, I'll go ahead and kick off tests again.

@addaleax
Copy link
Member

Landed in d8ef981 (with nits addressed), thanks for the PR! 🎉

@addaleax addaleax closed this Aug 23, 2018
addaleax pushed a commit that referenced this pull request Aug 23, 2018
@addaleax
test: add comment describing test-fs-mkdir
d8ef981 
PR-URL: #22424
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ben Coe <bencoe@gmail.com>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
targos pushed a commit that referenced this pull request Aug 24, 2018
@targos
test: add comment describing test-fs-mkdir
43f595d 
PR-URL: #22424
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ben Coe <bencoe@gmail.com>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
addaleax pushed a commit that referenced this pull request Sep 3, 2018
@addaleax
test: add comment describing test-fs-mkdir
e7dcfcc 
PR-URL: #22424
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ben Coe <bencoe@gmail.com>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
@profnandaa profnandaa mentioned this pull request Sep 9, 2018
Closed
targos pushed a commit that referenced this pull request Sep 12, 2018
@targos
test: add comment describing test-fs-mkdir
b1be08f 
PR-URL: #22424
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ben Coe <bencoe@gmail.com>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
@targos targos mentioned this pull request Sep 18, 2018
Merged
targos pushed a commit that referenced this pull request Sep 19, 2018
@targos
test: add comment describing test-fs-mkdir
08411d8 
PR-URL: #22424
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ben Coe <bencoe@gmail.com>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
@targos
Copy link
Member

targos commented Sep 20, 2018

Depends on #21875. Marking dont-land-on-v10.x for now.

@targos targos mentioned this pull request Sep 20, 2018
Closed
4 tasks
targos pushed a commit that referenced this pull request Sep 25, 2018
@targos
test: add comment describing test-fs-mkdir
a3b3485 
PR-URL: #22424
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ben Coe <bencoe@gmail.com>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
@targos targos mentioned this pull request Oct 7, 2018
Merged
This was referenced Oct 10, 2018
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@trivikr trivikr trivikr approved these changes

@BridgeAR BridgeAR BridgeAR approved these changes

@gireeshpunathil gireeshpunathil gireeshpunathil approved these changes

@richardlau richardlau richardlau approved these changes

@TimothyGu TimothyGu TimothyGu approved these changes

@addaleax addaleax addaleax approved these changes

@Trott Trott Trott approved these changes

@jasnell jasnell jasnell approved these changes

@bcoe bcoe bcoe approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. test Issues and PRs related to the tests.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.