Skip to content

docs: enhance JSDoc standards and document package structure#7182

Merged
BridgeAR merged 1 commit intomasterfrom
watson/more-code-conventions
Jan 6, 2026
Merged

docs: enhance JSDoc standards and document package structure#7182
BridgeAR merged 1 commit intomasterfrom
watson/more-code-conventions

Conversation

@watson
Copy link
Copy Markdown
Collaborator

@watson watson commented Jan 6, 2026

Enhances the developer documentation to improve clarity around JSDoc standards and document the standard package structure. Updates both AGENTS.md (AI agent guidelines) and CONTRIBUTING.md (human contributor guidelines) to maintain consistency.

For AI agents (AGENTS.md):

  1. Package structure wasn't documented - Added explicit documentation of the standard src/ and test/ directory layout with *.spec.js naming conventions used consistently across all packages. This helps agents quickly understand project organization.

  2. 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 any type, which helps agents maintain type safety.

  3. Removed duplicate guidance - The Node.js core module prefix requirement was already covered in the Import Ordering section.

For human contributors (CONTRIBUTING.md):

  • Aligned JSDoc documentation to match AGENTS.md, including the explicit rule against using any type in JSDoc annotations.

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
@watson watson requested a review from a team as a code owner January 6, 2026 18:04
@watson watson self-assigned this Jan 6, 2026
Copy link
Copy Markdown
Collaborator Author

watson commented Jan 6, 2026

This stack of pull requests is managed by Graphite. Learn more about stacking.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 6, 2026

Overall package size

Self size: 4.39 MB
Deduped: 5.21 MB
No deduping: 5.21 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 BridgeAR enabled auto-merge (squash) January 6, 2026 18:10
@codecov
Copy link
Copy Markdown

codecov Bot commented Jan 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.51%. Comparing base (2681a5e) to head (afcde6f).
⚠️ Report is 1 commits behind head on master.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@BridgeAR BridgeAR merged commit d401472 into master Jan 6, 2026
834 of 836 checks passed
@BridgeAR BridgeAR deleted the watson/more-code-conventions branch January 6, 2026 18:34
@dd-octo-sts dd-octo-sts Bot mentioned this pull request Jan 12, 2026
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants