Skip to content

doc: update testing documentation - #56953

Merged
aduh95 merged 2 commits into
nodejs:mainfrom
Aditi-1400:test-doc-update
Feb 15, 2025
Merged

doc: update testing documentation#56953
aduh95 merged 2 commits into
nodejs:mainfrom
Aditi-1400:test-doc-update

Conversation

@Aditi-1400

Copy link
Copy Markdown
Contributor

This update improves the test/common/README.md file by explaining why the common module is essential when writing tests.

I became curious about its importance while working on PR #56942, and @joyeecheung kindly provided the additional context that was missing from the documentation. :)

@nodejs-github-botnodejs-github-bot added needs-ci PRs that need a full CI run. test Issues and PRs related to the tests. labels Feb 7, 2025

@joyeecheungjoyeecheung left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM, thanks!

@codecov

codecovBot commented Feb 7, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.10%. Comparing base (048a17a) to head (2effd24).
Report is 69 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #56953 +/- ##
==========================================
- Coverage 89.15% 89.10% -0.06% 
==========================================
Files 665 665 Lines 192846 193206 +360 Branches 37145 37217 +72 ==========================================
+ Hits 171926 172150 +224 - Misses 13696 13760 +64 - Partials 7224 7296 +72 

see 51 files with indirect coverage changes

@joyeecheungjoyeecheung added the commit-queue Add this label to land a pull request using GitHub Actions. label Feb 13, 2025
@nodejs-github-botnodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Feb 13, 2025
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator
Commit Queue failed
- Loading data for nodejs/node/pull/56953
✔ Done loading data for nodejs/node/pull/56953
----------------------------------- PR info ------------------------------------
Title doc: update testing documentation (#56953)
⚠ Could not retrieve the email or name of the PR author's from user's GitHub profile!
Branch Aditi-1400:test-doc-update -> nodejs:main
Labels test, needs-ci
Commits 1
- doc: update testing documentation
Committers 1
- Aditi <aditisingh1400@gmail.com>
PR-URL: https://github.com/nodejs/node/pull/56953
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/56953
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
--------------------------------------------------------------------------------
ℹ This PR was created on Fri, 07 Feb 2025 20:42:22 GMT
✔ Approvals: 1
✔ - Joyee Cheung (@joyeecheung) (TSC): https://github.com/nodejs/node/pull/56953#pullrequestreview-2602840643
✘ This PR needs to wait 29 more hours to land (or 0 hours if there is one more approval)
✔ Last GitHub CI successful
✘ No Jenkins CI runs detected
--------------------------------------------------------------------------------
✔ Aborted `git node land` session in /home/runner/work/node/node/.ncu
https://github.com/nodejs/node/actions/runs/13311410448

@richardlaurichardlau added commit-queue Add this label to land a pull request using GitHub Actions. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels Feb 13, 2025
@nodejs-github-botnodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Feb 13, 2025
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator
Commit Queue failed
- Loading data for nodejs/node/pull/56953
✔ Done loading data for nodejs/node/pull/56953
----------------------------------- PR info ------------------------------------
Title doc: update testing documentation (#56953)
⚠ Could not retrieve the email or name of the PR author's from user's GitHub profile!
Branch Aditi-1400:test-doc-update -> nodejs:main
Labels test, needs-ci
Commits 1
- doc: update testing documentation
Committers 1
- Aditi <aditisingh1400@gmail.com>
PR-URL: https://github.com/nodejs/node/pull/56953
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/56953
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
--------------------------------------------------------------------------------
ℹ This PR was created on Fri, 07 Feb 2025 20:42:22 GMT
✔ Approvals: 2
✔ - Joyee Cheung (@joyeecheung) (TSC): https://github.com/nodejs/node/pull/56953#pullrequestreview-2602840643
✔ - Richard Lau (@richardlau) (TSC): https://github.com/nodejs/node/pull/56953#pullrequestreview-2615467845
✔ Last GitHub CI successful
✘ No Jenkins CI runs detected
--------------------------------------------------------------------------------
✔ Aborted `git node land` session in /home/runner/work/node/node/.ncu
https://github.com/nodejs/node/actions/runs/13311572887

@aduh95aduh95 removed needs-ci PRs that need a full CI run. commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels Feb 15, 2025
Comment threadtest/common/README.md Outdated
@aduh95
aduh95 merged commit 794f35f into nodejs:mainFeb 15, 2025
@aduh95

Copy link
Copy Markdown
Contributor

Landed in 794f35f

targos pushed a commit that referenced this pull request Feb 17, 2025
PR-URL: #56953
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
acidiney pushed a commit to acidiney/node that referenced this pull request Feb 23, 2025
PR-URL: nodejs#56953
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
aduh95 pushed a commit that referenced this pull request Apr 2, 2025
PR-URL: #56953
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
aduh95 pushed a commit that referenced this pull request Apr 3, 2025
PR-URL: #56953
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
RafaelGSS pushed a commit that referenced this pull request Apr 16, 2025
PR-URL: #56953
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
RafaelGSS pushed a commit that referenced this pull request Apr 17, 2025
PR-URL: #56953
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
marco-ippolito pushed a commit that referenced this pull request Aug 18, 2025
PR-URL: #56953
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
marco-ippolito pushed a commit that referenced this pull request Aug 20, 2025
PR-URL: #56953
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
marco-ippolito pushed a commit that referenced this pull request Aug 25, 2025
PR-URL: #56953
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
marco-ippolito pushed a commit that referenced this pull request Aug 25, 2025
PR-URL: #56953
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
marco-ippolito pushed a commit that referenced this pull request Aug 27, 2025
PR-URL: #56953
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

testIssues and PRs related to the tests.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@Aditi-1400@nodejs-github-bot@aduh95@joyeecheung@richardlau@ayman199709