Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (31 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

45 lines (31 loc) · 1.5 KB
Raw

Contributing

Thanks for your interest in improving knowledge-base.

Development setup

npm install            # Node >= 24
npm run build:headless # hermetic build from the vendored fixture (tests/fixtures/)
npm test               # embedded web-fragment E2E (Playwright)

The build and tests are fully hermetic — they use the committed tests/fixtures/docs-example.dist.tar.gz fixture (registered via apps.json), so no GITHUB_TOKEN, network, or sibling repository is required.

See CLAUDE.md for an architecture overview and the full command list, and README.md for usage.

Tests

Command What it runs
npm test Embedded web-fragment harness (playwright.config.js) — host gateway proxies/embeds the fragment on :4201.
npx playwright test --config=playwright.config.ci.js Standalone fragment-server layer (:3000) — headers, headless contract, asset routing, #297.

Both run in CI (.github/workflows/ci.yml). Please make sure both pass before opening a PR.

Pull requests

  1. Branch off master.
  2. Keep changes focused; update docs/tests alongside code.
  3. Ensure npm run build:headless, npm test, and the standalone suite pass.
  4. CI (type-check, build, E2E, audit) must be green.

Reporting security issues

Please follow SECURITY.md — do not file public issues for vulnerabilities.

License

By contributing, you agree that your contributions are licensed under the Apache License 2.0.