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.

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

docs: update CONTRIBUTING.md with guidelines on using the node: namespace #146

Merged
merged 1 commit into from
Dec 16, 2024

Conversation

lumirlumir
Copy link
Owner

This pull request includes an update to the CONTRIBUTING.md file to provide guidance on the usage of the node: namespace prefix for built-in modules in Node.js. The most important change is the addition of a new section explaining the recommended usage patterns for different parts of the project.

Documentation updates:

  • CONTRIBUTING.md: Added a new section titled "Others" with a subsection on the node: namespace. It explains that standard imports without the node: prefix should be used for regular application code for broader compatibility, while the node: prefix can be used in test files that use the node:test runner.

@github-actions github-actions bot added the docs label Dec 16, 2024
Copy link

Labels have been automatically applied based on the conventional commit types.🏷️

Copy link

codecov bot commented Dec 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (0c6424a) to head (0ec92a0).
Report is 1 commits behind head on main.

@@            Coverage Diff            @@
##              main      #146   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           11        11           
  Lines           64        64           
=========================================
  Hits            64        64           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0c6424a...0ec92a0. Read the comment docs.

@lumirlumir lumirlumir merged commit 4b14b18 into main Dec 16, 2024
4 of 6 checks passed
@lumirlumir lumirlumir deleted the docs-contributing-others-node-namespace branch December 16, 2024 09:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant