Skip to content

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

Draft
pritesh-jain-cstk wants to merge 4 commits into
masterfrom
docs/MKT-22144-claude-md
Draft

pritesh-jain-cstk wants to merge 4 commits into
masterfrom
docs/MKT-22144-claude-md

Conversation

@pritesh-jain-cstk

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

Copy link
Copy Markdown

Branch graph

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

Merge order: #68 before #69 (#69 is based on #68). #64 and #69 both change package.json and package-lock.json: merge #64 first, then bring master into #69 with a merge (no rebase) and regenerate the lock with npm install --legacy-peer-deps (expect a lock conflict). #65, #66, #67 and #70 are independent.

graph LR
  master --> bug1["Bug: host-only extensionEvent MKT-22139"]
  master --> bug2["Bug: getField console.log MKT-22140"]
  master --> sec["Security: Dependabot MKT-22141"]
  master --> s64["Snyk/audit + LICENSE: existing #64"]
  master --> tests["[Tests] MKT-22142"]
  tests --> ci["[Routine] MKT-22143"]
  master --> docs["[Docs] MKT-22144"]
  style docs fill:#f9d71c,stroke:#333,stroke-width:2px
Loading

What

Jira: MKT-22144

Consumer impact: none. Docs and .gitignore only; neither file is in the published files list.

  • CLAUDE.md (public-safe facts only, no internal workflow section or tracker keys): what the SDK is, stack and commands (including why npm ci needs --legacy-peer-deps), the public-API contract (no breaking change; runtime change only for a confirmed bug fix, stated in the PR; host-only listeners, linking fix(security): accept extensionEvent only from window.parent #65; no data in console; current error-message text kept as the prefix), layout, review rules as ruleset 22725457 states them (tests run on PRs once ci: unit tests on pull requests (Node 24); untrack coverage; declare and prune dependencies #69 merges), Definition of Done.
  • CONTRIBUTING.md: issues, security route via SECURITY.md, PR steps, MIT licence for contributions.
  • .gitignore: .env, .env.*. 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), security.env-not-tracked

Commands (exit codes, Node 24 locally)

Command master this branch
npm ci 1 (ERESOLVE, pre-existing) 1 (same)
npm ci --legacy-peer-deps 0 0
npm run build 0 (26 ESLint warnings) 0 (same)
lint / typecheck n/a (lint runs inside build; plain JS) n/a
npm test 1 (5 failed, 128 passed) 1 (same, no code change)
npm audit --omit=dev 0 0

Commits went through the repo's hooks (GitGuardian pre-commit and pre-push); none bypassed. Local Snyk cannot authenticate (org permission / 401), so the PR's Snyk checks are the scan.

CI: security-license fails here as on master: it requires the current year in LICENSE (still 2019-2025). Fixed by #64 (DX-29607), not by this PR. All Snyk, GitGuardian, CodeQL and policy checks pass.

🤖 Generated with Claude Code

MKT-22144. Also ignore .env files (the library reads none).

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

snyk-io Bot commented Nov 4, 2026 •

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 0 0 25 ✅ Passed
🟡 Medium Severity 0 0 500 ✅ Passed
🔵 Low Severity 0 0 1000 ✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

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

✅ BUILD PASSED - All security checks passed

MKT-22144.

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 0 0 25 ✅ Passed
🟡 Medium Severity 0 0 500 ✅ Passed
🔵 Low Severity 0 0 1000 ✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

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

✅ BUILD PASSED - All security checks passed

…text

MKT-22144.

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 0 0 25 ✅ Passed
🟡 Medium Severity 0 0 500 ✅ Passed
🔵 Low Severity 0 0 1000 ✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

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

✅ BUILD PASSED - All security checks passed

Drop the internal workflow section and internal tracker keys; link the
host-only listener fix by PR instead.

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 0 0 25 ✅ Passed
🟡 Medium Severity 0 0 500 ✅ Passed
🔵 Low Severity 0 0 1000 ✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

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

✅ BUILD PASSED - All security checks passed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants