docs(guardrails): enforce JSDoc on every new or modified function

[Copilot]

Summary

• What changed: Added JSDoc requirement to guardrails; logged recurring mistake in ERRORS.md
• Why: Recent PRs introduced undocumented functions; making this an always-on constraint
• Supersedes / Related: Addresses bot review feedback on clarifying @return usage

Scope

• Module(s) impacted: Documentation only
• Cross-module impact: none
• Risk level: low

Validation

• npm run lint
• npm test (N/A - docs only)
• Manual checks done: verified @return is dominant convention (77 vs 13 @returns)

Guardrails check

• No secrets or credentials introduced (.env*, secrets/**, keys, tokens)
• No risky rename/move of core stack paths
• Changes remain merge-friendly for downstream projects
• Tests added or updated when behavior changed (N/A - docs only)

Optional: Infra/Stack alignment details

Before vs After (key changes only)

Area	Before	After	Notes
Guardrails	No JSDoc requirement	Mandatory JSDoc on new/modified functions	Uses @return (not @returns) for consistency
Error log	No entry	Added 2026-02-22 entry	Captures recurring mistake pattern

• Upstream parity target / source: N/A
• Automation or policy impact (CI, Dependabot, auto-merge, majors, permissions): None
• Rollback plan: Revert commits; no runtime impact

Notes for reviewers

• Security considerations: None - documentation only
• Mergeability considerations: Minimal diff; no code paths changed; downstream merges unaffected
• Follow-up tasks (optional): Consider linting rule to enforce JSDoc presence (future enhancement)

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[Copilot]

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• downloads.snyk.io
  • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node node wrapper_dist/bootstrap.js exec (dns block)
• o30291.ingest.sentry.io
  • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node node wrapper_dist/bootstrap.js exec (dns block)
• scarf.sh
  • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node node ./report.js (dns block)
• static.snyk.io
  • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node node wrapper_dist/bootstrap.js exec (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)