Developer Workflow

This page summarizes the standard SDK repository workflow.

Repository Layout

  • src/: SDK source (hooks, config, components, utils, dev harness, testing)

  • tests/: package level tests

  • docs/src/: documentation source

  • dist/: build outputs

  • scripts/: release/changelog helper scripts

Standard Commands

npm run lint
npm run test
npm run build

Make Targets

Common targets include:

  • make lint

  • make test

  • make build

  • make docs-build html

Local Docs Preview

make docs-build html

Then open:

docs/build/html/index.html

Release Notes

make bump-version updates package version metadata and release files used by CI workflows.

Working With Example Widgets

Use octopus-widgets/ska-octopus-components-table-widget and octopus-widgets/ska-octopus-grid-widget as practical references when changing SDK behavior.