Contribution

Contribution Development Setup

Set up the repository, build the runtime, run the local verification flows, and preview the docs before changing public behavior.

Prerequisites

  • Go 1.24+
  • Node.js 20+
  • Yarn 4+
  • Python 3.10+
  • protoc

Install Workspace Dependencies

yarn install

Build The Project

make

For explicit runtime builds:

cd packages/api
go build -tags "gosseract opencv gocv_specific_modules gocv_features2d gocv_calib3d" \
  -trimpath -ldflags="-s -w" -o ../../sikuli-go ./cmd/sikuli-go
go build -tags "gosseract opencv gocv_specific_modules gocv_features2d gocv_calib3d" \
  -trimpath -ldflags="-s -w" -o ../../sikuli-go-monitor ./cmd/sikuli-go-monitor

Verify The Repo

Quick publish-oriented verification:

make test-publish

Broader integration verification:

make test-integration

Docs And Generated Artifacts

Run the docs governance check:

./scripts/check-docs-governance.sh

Run the internal docs link check:

./scripts/check-docs-links.sh

Regenerate API docs when needed:

./scripts/generate-api-docs.sh

Regenerate parity docs when needed:

./scripts/generate-parity-docs.sh

Preview the docs locally:

make docs

The local preview server serves staged markdown through the guide shell when Jekyll is not available, so the browser view stays close to the published Pages layout. When .test-results/bench exists, make docs also regenerates the benchmark guide pages under /bench/ and /bench/reports/ before serving them.

For a non-interactive local check without opening a browser or keeping the server running:

DOCS_LOCAL_OPEN_BROWSER=0 DOCS_LOCAL_SERVE=0 make docs

Key Workflow References