Skip to content

docs(contributing): document advisory DB setup for full test suite - #1041

Merged
sonukapoor merged 1 commit into
OWASP:mainfrom
luojiyin1987:docs/contributing-advisory-sync
Aug 23, 2026
Merged

sonukapoor merged 1 commit into
OWASP:mainfrom
luojiyin1987:docs/contributing-advisory-sync

Conversation

@luojiyin1987

Copy link
Copy Markdown
Collaborator

Fixes #1040

Summary

  • Replace the two-command verification snippet (npm test, npm run build) with the five-step sequence from .github/workflows/ci.yml.
  • Explain why advisories sync runs before npm test: e2e tests that scan with --offline read the local advisory database. Without the sync, those tests fail while the rest of the suite passes.

Docs only. No code or test changes (+12/-2 in CONTRIBUTING.md).

@sonukapoor sonukapoor left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Accurate and helpful - the five-step sequence matches CI exactly, and the explanation of why advisories sync has to run before npm test saves the next contributor from a confusing partial failure. Merging.

@sonukapoor
sonukapoor merged commit 6e9aca7 into OWASP:main Aug 23, 2026
6 checks passed
@sonukapoor

Copy link
Copy Markdown
Collaborator

Merged - thank you @luojiyin1987!

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.

CONTRIBUTING.md: document advisory DB sync required by the full test suite

2 participants