docs: enhance JSDoc standards and document package structure#7182
Merged
docs: enhance JSDoc standards and document package structure#7182
Conversation
CONTRIBUTING.md - Add guideline to never use 'any' type in JSDoc annotations AGENTS.md - Add package structure section explaining src/test directory layout - Add guideline to never use 'any' type in JSDoc annotations - Remove redundant Node.js core module prefix bullet point
Contributor
Overall package sizeSelf size: 4.39 MB Dependency sizes| name | version | self size | total size | |------|---------|-----------|------------| | import-in-the-middle | 2.0.0 | 68.46 kB | 797.03 kB | | dc-polyfill | 0.1.10 | 26.73 kB | 26.73 kB |🤖 This report was automatically generated by heaviest-objects-in-the-universe |
BridgeAR
approved these changes
Jan 6, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #7182 +/- ##
=======================================
Coverage 84.51% 84.51%
=======================================
Files 525 525
Lines 22492 22492
=======================================
Hits 19008 19008
Misses 3484 3484 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Merged
dd-octo-sts Bot
pushed a commit
that referenced
this pull request
Jan 12, 2026
CONTRIBUTING.md - Add guideline to never use 'any' type in JSDoc annotations AGENTS.md - Add package structure section explaining src/test directory layout - Add guideline to never use 'any' type in JSDoc annotations - Remove redundant Node.js core module prefix bullet point
nina9753
pushed a commit
that referenced
this pull request
Jan 15, 2026
CONTRIBUTING.md - Add guideline to never use 'any' type in JSDoc annotations AGENTS.md - Add package structure section explaining src/test directory layout - Add guideline to never use 'any' type in JSDoc annotations - Remove redundant Node.js core module prefix bullet point
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Enhances the developer documentation to improve clarity around JSDoc standards and document the standard package structure. Updates both
AGENTS.md(AI agent guidelines) andCONTRIBUTING.md(human contributor guidelines) to maintain consistency.For AI agents (AGENTS.md):
Package structure wasn't documented - Added explicit documentation of the standard
src/andtest/directory layout with*.spec.jsnaming conventions used consistently across all packages. This helps agents quickly understand project organization.JSDoc standards needed better visibility - Separated JSDoc into its own subsection (was buried as a single bullet point) and added explicit guidance to never use the
anytype, which helps agents maintain type safety.Removed duplicate guidance - The Node.js core module prefix requirement was already covered in the Import Ordering section.
For human contributors (CONTRIBUTING.md):
AGENTS.md, including the explicit rule against usinganytype in JSDoc annotations.