Skip to content

docs: CLAUDE.md (API contract, review rules, DoD) and CONTRIBUTING.md - #197

Draft
pritesh-jain-cstk wants to merge 3 commits into
mainfrom
docs/MKT-22132-claude-md
Draft

docs: CLAUDE.md (API contract, review rules, DoD) and CONTRIBUTING.md#197
pritesh-jain-cstk wants to merge 3 commits into
mainfrom
docs/MKT-22132-claude-md

Conversation

@pritesh-jain-cstk

@pritesh-jain-cstk pritesh-jain-cstk commented Nov 4, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Merge after #193: the CLAUDE.md rule on host-only listeners describes main once #193 is in.

Branch graph

Epic MKT-21672. This PR is highlighted. Only [Routine] depends on [Tests]; the rest are independent.

graph LR
  main --> bug["Bug: host-only listeners MKT-22128"]
  main --> hyg["Security: Dependabot MKT-22129"]
  main --> s191["Snyk axios: existing #191"]
  main --> tests["[Tests] MKT-22130"]
  tests --> ci["[Routine] MKT-22131"]
  main --> docs["[Docs] MKT-22132"]
  style docs fill:#f9d71c,stroke:#333,stroke-width:2px
Loading

What

Jira: MKT-22132

Consumer impact: none. Built main and this branch and diffed dist/src/**/*.d.ts: no diff. Docs only; neither file is in the published files list.

  • CLAUDE.md (public-safe: no internal workflow block, wiki links or Jira keys): stack and commands, the public-API contract (no breaking change; runtime change only for a confirmed bug fix, stated in the PR with the typings diff), layout, known traps stated inline, review rules as ruleset 22716531 states them (the unit-test workflow is not a required check), Definition of Done.
  • CONTRIBUTING.md: issues, security route via SECURITY.md, PR steps, MIT licence for contributions.
  • No env sample: the library reads no environment variables.
  • Not added: CODE_OF_CONDUCT.md, which needs an enforcement contact from the owners.

Readiness items

routine.agents-md, dev.review-rules, sdlc.definition-of-done, legal.licence-eula (CONTRIBUTING part)

Commands (exit codes, Node 24 locally)

Command main this branch
npm ci 0 0
npm run lint 1 (8 warnings, pre-existing) 1 (same 8, none added)
npm run build 0 0
npx tsc --noEmit -p . 0 0
npm test 0 (249 passed) 0 (249 passed; docs only)
npm audit --omit=dev 1 (3 High: axios, follow-redirects; fixed by #191) 1 (unchanged)

CI: security-sca fails here as on main: the lock pins axios 1.16.0 (8 High). That is fixed by #191 (MKT-22129 links it), not by this PR. The pre-push hook (npm test) passed on every push; none bypassed. Local Snyk cannot authenticate (SNYK-0005); the PR's Snyk checks are the scan.

🤖 Generated with Claude Code

@PriteshJain @claude
docs: add CLAUDE.md (API contract, review rules, DoD) and CONTRIBUTIN…
90713b5 
…G.md (MKT-22132)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@snyk-io

snyk-io Bot commented Nov 4, 2026 •
edited
Loading

Copy link
Copy Markdown

✅ Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
✅ Open Source Security 0 0 0 0 0 issues
✅ Licenses 0 0 0 0 0 issues
✅ Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@github-actions

github-actions Bot commented Nov 4, 2026

Copy link
Copy Markdown

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check Type Count (with fixes) Without fixes Threshold Result
🔴 Critical Severity 0 0 10 ✅ Passed
🟠 High Severity 6 2 25 ✅ Passed
🟡 Medium Severity 15 2 500 ✅ Passed
🔵 Low Severity 0 0 1000 ✅ Passed

⏱️ SLA Breach Summary

⚠️ Warning: The following vulnerabilities have exceeded their SLA thresholds (days since publication).

Severity Breaches (with fixes) Breaches (no fixes) SLA Threshold (with/no fixes) Status
🔴 Critical 0 0 15 / 30 days ✅ Passed
🟠 High 6 0 30 / 120 days ❌ Failed
🟡 Medium 10 0 90 / 365 days ❌ Failed
🔵 Low 0 0 180 / 365 days ✅ Passed

🟠 High Severity - SLA Breached Issues (with fixes)

Showing 6 issue(s) that have exceeded the 30-day SLA threshold:

  1. Improper Validation of Specified Quantity in Input

    • ID: SNYK-JS-AXIOS-20245046
    • Package: axios@1.16.0
    • Published: 35 days ago (SLA: 30 days)
    • CVSS Score: 8.2
    • CVE: CVE-2026-101901

  2. Server-side Request Forgery (SSRF)

    • ID: SNYK-JS-AXIOS-20245060
    • Package: axios@1.16.0
    • Published: 35 days ago (SLA: 30 days)
    • CVSS Score: 7
    • CVE: CVE-2026-101898

  3. Allocation of Resources Without Limits or Throttling

    • ID: SNYK-JS-AXIOS-20245062
    • Package: axios@1.16.0
    • Published: 35 days ago (SLA: 30 days)
    • CVSS Score: 8.2
    • CVE: CVE-2026-101906

  4. Improper Validation of Specified Quantity in Input

    • ID: SNYK-JS-AXIOS-20245044
    • Package: axios@1.16.0
    • Published: 35 days ago (SLA: 30 days)
    • CVSS Score: 8.2
    • CVE: CVE-2026-101901

  5. Unintended Proxy or Intermediary ('Confused Deputy')

    • ID: SNYK-JS-AXIOS-20245048
    • Package: axios@1.16.0
    • Published: 35 days ago (SLA: 30 days)
    • CVSS Score: 7.6
    • CVE: CVE-2026-101905

  6. Prototype Pollution

    • ID: SNYK-JS-AXIOS-20245066
    • Package: axios@1.16.0
    • Published: 35 days ago (SLA: 30 days)
    • CVSS Score: 8.3
    • CVE: CVE-2026-101909

🟡 Medium Severity - SLA Breached Issues (with fixes)

Showing 10 issue(s) that have exceeded the 90-day SLA threshold:

  1. Prototype Pollution

    • ID: SNYK-JS-AXIOS-18065349
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.3
    • CVE: CVE-2026-67319

  2. Uncontrolled Recursion

    • ID: SNYK-JS-AXIOS-18060167
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.3
    • CVE: CVE-2026-67313

  3. Prototype Pollution

    • ID: SNYK-JS-AXIOS-18060659
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.3
    • CVE: CVE-2026-67314

  4. Permissive List of Allowed Inputs

    • ID: SNYK-JS-AXIOS-18065357
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.9
    • CVE: CVE-2026-67315

  5. Allocation of Resources Without Limits or Throttling

    • ID: SNYK-JS-AXIOS-18060165
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.3
    • CVE: CVE-2026-67312

  6. Uncontrolled Recursion

    • ID: SNYK-JS-AXIOS-18060730
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.9
    • CVE: CVE-2026-67321

  7. Allocation of Resources Without Limits or Throttling

    • ID: SNYK-JS-AXIOS-18060804
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.3
    • CVE: CVE-2026-67318

  8. Allocation of Resources Without Limits or Throttling

    • ID: SNYK-JS-AXIOS-18065353
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.3
    • CVE: CVE-2026-67317

  9. Prototype Pollution

    • ID: SNYK-JS-AXIOS-18065355
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.3
    • CVE: CVE-2026-67316

  10. Prototype Pollution

  • ID: SNYK-JS-AXIOS-18065351
  • Package: axios@1.16.0
  • Published: 105 days ago (SLA: 90 days)
  • CVSS Score: 6.9
  • CVE: CVE-2026-67320

ℹ️ Vulnerabilities Without Available Fixes (Informational Only)

The following vulnerabilities were detected but do not have fixes available (no upgrade or patch). These are excluded from failure thresholds:

  • Critical without fixes: 0
  • High without fixes: 2
  • Medium without fixes: 2
  • Low without fixes: 0

❌ BUILD FAILED - Security checks failed

Please review and fix the security vulnerabilities before merging.

@PriteshJain @claude
docs: host-only listener rule applies after #193 merges (MKT-22132)
2f2bf41 
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Nov 4, 2026

Copy link
Copy Markdown

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check Type Count (with fixes) Without fixes Threshold Result
🔴 Critical Severity 0 0 10 ✅ Passed
🟠 High Severity 6 2 25 ✅ Passed
🟡 Medium Severity 15 2 500 ✅ Passed
🔵 Low Severity 0 0 1000 ✅ Passed

⏱️ SLA Breach Summary

⚠️ Warning: The following vulnerabilities have exceeded their SLA thresholds (days since publication).

Severity Breaches (with fixes) Breaches (no fixes) SLA Threshold (with/no fixes) Status
🔴 Critical 0 0 15 / 30 days ✅ Passed
🟠 High 6 0 30 / 120 days ❌ Failed
🟡 Medium 10 0 90 / 365 days ❌ Failed
🔵 Low 0 0 180 / 365 days ✅ Passed

🟠 High Severity - SLA Breached Issues (with fixes)

Showing 6 issue(s) that have exceeded the 30-day SLA threshold:

  1. Improper Validation of Specified Quantity in Input

    • ID: SNYK-JS-AXIOS-20245046
    • Package: axios@1.16.0
    • Published: 35 days ago (SLA: 30 days)
    • CVSS Score: 8.2
    • CVE: CVE-2026-101901

  2. Server-side Request Forgery (SSRF)

    • ID: SNYK-JS-AXIOS-20245060
    • Package: axios@1.16.0
    • Published: 35 days ago (SLA: 30 days)
    • CVSS Score: 7
    • CVE: CVE-2026-101898

  3. Allocation of Resources Without Limits or Throttling

    • ID: SNYK-JS-AXIOS-20245062
    • Package: axios@1.16.0
    • Published: 35 days ago (SLA: 30 days)
    • CVSS Score: 8.2
    • CVE: CVE-2026-101906

  4. Improper Validation of Specified Quantity in Input

    • ID: SNYK-JS-AXIOS-20245044
    • Package: axios@1.16.0
    • Published: 35 days ago (SLA: 30 days)
    • CVSS Score: 8.2
    • CVE: CVE-2026-101901

  5. Prototype Pollution

    • ID: SNYK-JS-AXIOS-20245066
    • Package: axios@1.16.0
    • Published: 35 days ago (SLA: 30 days)
    • CVSS Score: 8.3
    • CVE: CVE-2026-101909

  6. Unintended Proxy or Intermediary ('Confused Deputy')

    • ID: SNYK-JS-AXIOS-20245048
    • Package: axios@1.16.0
    • Published: 35 days ago (SLA: 30 days)
    • CVSS Score: 7.6
    • CVE: CVE-2026-101905

🟡 Medium Severity - SLA Breached Issues (with fixes)

Showing 10 issue(s) that have exceeded the 90-day SLA threshold:

  1. Uncontrolled Recursion

    • ID: SNYK-JS-AXIOS-18060167
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.3
    • CVE: CVE-2026-67313

  2. Prototype Pollution

    • ID: SNYK-JS-AXIOS-18060659
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.3
    • CVE: CVE-2026-67314

  3. Prototype Pollution

    • ID: SNYK-JS-AXIOS-18065351
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.9
    • CVE: CVE-2026-67320

  4. Prototype Pollution

    • ID: SNYK-JS-AXIOS-18065355
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.3
    • CVE: CVE-2026-67316

  5. Allocation of Resources Without Limits or Throttling

    • ID: SNYK-JS-AXIOS-18060804
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.3
    • CVE: CVE-2026-67318

  6. Permissive List of Allowed Inputs

    • ID: SNYK-JS-AXIOS-18065357
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.9
    • CVE: CVE-2026-67315

  7. Uncontrolled Recursion

    • ID: SNYK-JS-AXIOS-18060730
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.9
    • CVE: CVE-2026-67321

  8. Prototype Pollution

    • ID: SNYK-JS-AXIOS-18065349
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.3
    • CVE: CVE-2026-67319

  9. Allocation of Resources Without Limits or Throttling

    • ID: SNYK-JS-AXIOS-18060165
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.3
    • CVE: CVE-2026-67312

  10. Allocation of Resources Without Limits or Throttling

  • ID: SNYK-JS-AXIOS-18065353
  • Package: axios@1.16.0
  • Published: 105 days ago (SLA: 90 days)
  • CVSS Score: 6.3
  • CVE: CVE-2026-67317

ℹ️ Vulnerabilities Without Available Fixes (Informational Only)

The following vulnerabilities were detected but do not have fixes available (no upgrade or patch). These are excluded from failure thresholds:

  • Critical without fixes: 0
  • High without fixes: 2
  • Medium without fixes: 2
  • Low without fixes: 0

❌ BUILD FAILED - Security checks failed

Please review and fix the security vulnerabilities before merging.

@PriteshJain @claude
docs: keep CLAUDE.md public-safe (MKT-22132)
48ba87c 
Drop the internal workflow block, internal wiki links and Jira keys;
known traps stated inline; listener rule links PR #193.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Nov 4, 2026

Copy link
Copy Markdown

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check Type Count (with fixes) Without fixes Threshold Result
🔴 Critical Severity 0 0 10 ✅ Passed
🟠 High Severity 6 2 25 ✅ Passed
🟡 Medium Severity 15 2 500 ✅ Passed
🔵 Low Severity 0 0 1000 ✅ Passed

⏱️ SLA Breach Summary

⚠️ Warning: The following vulnerabilities have exceeded their SLA thresholds (days since publication).

Severity Breaches (with fixes) Breaches (no fixes) SLA Threshold (with/no fixes) Status
🔴 Critical 0 0 15 / 30 days ✅ Passed
🟠 High 6 0 30 / 120 days ❌ Failed
🟡 Medium 10 0 90 / 365 days ❌ Failed
🔵 Low 0 0 180 / 365 days ✅ Passed

🟠 High Severity - SLA Breached Issues (with fixes)

Showing 6 issue(s) that have exceeded the 30-day SLA threshold:

  1. Server-side Request Forgery (SSRF)

    • ID: SNYK-JS-AXIOS-20245060
    • Package: axios@1.16.0
    • Published: 35 days ago (SLA: 30 days)
    • CVSS Score: 7
    • CVE: CVE-2026-101898

  2. Prototype Pollution

    • ID: SNYK-JS-AXIOS-20245066
    • Package: axios@1.16.0
    • Published: 35 days ago (SLA: 30 days)
    • CVSS Score: 8.3
    • CVE: CVE-2026-101909

  3. Improper Validation of Specified Quantity in Input

    • ID: SNYK-JS-AXIOS-20245046
    • Package: axios@1.16.0
    • Published: 35 days ago (SLA: 30 days)
    • CVSS Score: 8.2
    • CVE: CVE-2026-101901

  4. Unintended Proxy or Intermediary ('Confused Deputy')

    • ID: SNYK-JS-AXIOS-20245048
    • Package: axios@1.16.0
    • Published: 35 days ago (SLA: 30 days)
    • CVSS Score: 7.6
    • CVE: CVE-2026-101905

  5. Allocation of Resources Without Limits or Throttling

    • ID: SNYK-JS-AXIOS-20245062
    • Package: axios@1.16.0
    • Published: 35 days ago (SLA: 30 days)
    • CVSS Score: 8.2
    • CVE: CVE-2026-101906

  6. Improper Validation of Specified Quantity in Input

    • ID: SNYK-JS-AXIOS-20245044
    • Package: axios@1.16.0
    • Published: 35 days ago (SLA: 30 days)
    • CVSS Score: 8.2
    • CVE: CVE-2026-101901

🟡 Medium Severity - SLA Breached Issues (with fixes)

Showing 10 issue(s) that have exceeded the 90-day SLA threshold:

  1. Allocation of Resources Without Limits or Throttling

    • ID: SNYK-JS-AXIOS-18060804
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.3
    • CVE: CVE-2026-67318

  2. Prototype Pollution

    • ID: SNYK-JS-AXIOS-18065349
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.3
    • CVE: CVE-2026-67319

  3. Allocation of Resources Without Limits or Throttling

    • ID: SNYK-JS-AXIOS-18065353
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.3
    • CVE: CVE-2026-67317

  4. Allocation of Resources Without Limits or Throttling

    • ID: SNYK-JS-AXIOS-18060165
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.3
    • CVE: CVE-2026-67312

  5. Prototype Pollution

    • ID: SNYK-JS-AXIOS-18060659
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.3
    • CVE: CVE-2026-67314

  6. Permissive List of Allowed Inputs

    • ID: SNYK-JS-AXIOS-18065357
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.9
    • CVE: CVE-2026-67315

  7. Uncontrolled Recursion

    • ID: SNYK-JS-AXIOS-18060167
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.3
    • CVE: CVE-2026-67313

  8. Uncontrolled Recursion

    • ID: SNYK-JS-AXIOS-18060730
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.9
    • CVE: CVE-2026-67321

  9. Prototype Pollution

    • ID: SNYK-JS-AXIOS-18065351
    • Package: axios@1.16.0
    • Published: 105 days ago (SLA: 90 days)
    • CVSS Score: 6.9
    • CVE: CVE-2026-67320

  10. Prototype Pollution

  • ID: SNYK-JS-AXIOS-18065355
  • Package: axios@1.16.0
  • Published: 105 days ago (SLA: 90 days)
  • CVSS Score: 6.3
  • CVE: CVE-2026-67316

ℹ️ Vulnerabilities Without Available Fixes (Informational Only)

The following vulnerabilities were detected but do not have fixes available (no upgrade or patch). These are excluded from failure thresholds:

  • Critical without fixes: 0
  • High without fixes: 2
  • Medium without fixes: 2
  • Low without fixes: 0

❌ BUILD FAILED - Security checks failed

Please review and fix the security vulnerabilities before merging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@pritesh-jain-cstk @PriteshJain