-
Notifications
You must be signed in to change notification settings - Fork 30k
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
Update CONTRIBUTING.md to clarify single-test running #11231
Comments
By the way, this definitely comes up for real users. |
I don't know, it's still useful info for people trying to debug segfaults. The test runner only gets in the way then. |
Given that the first method suggested (directly above) is to run the test with If we are going to have more documentation about what the test runner does, it might be worth putting that somewhere else (like test/README.md) and just linking to said info from CONTRIBUTING.md. |
Maybe extend doc/guides/writing-tests.md a little? |
The way to run a single test using |
@joaocgreis It's immediately above the text we're talking about in this PR: If you are updating tests and just want to run a single test to check it, you can use this syntax to run it exactly as the test harness would: ```text $ python tools/test.py -v --mode=release parallel/test-stream2-transform ``` There's probably room to improve that text and/or make it more noticeable. |
@joaocgreis FYI, since #9694, you can use the full path, e.g. |
@Trott my bad, thanks for pointing it out. I agree with @gibfahn above, we could remove this from |
In
CONTRIBUTING.md
:This bit is a little problematic and can trip up new folks.
parallel
andsequential
) but not others (such asmessage
).--FLAGS
comment, then that needs to be taken into account on the command line or else the test won't work.We could clarify all this, or we could just remove that bit of text entirely and instruct people to always use
test.py
. That second option seems like the better one to me. Discuss.@nodejs/testing
The text was updated successfully, but these errors were encountered: