Community on TauGrid

Contributing

Mon, 01 Jan 0001 00:00:00 +0000

Start with the repository AGENTS.md and SDK_GUIDE.md.

Core principles:

Start from the user path and compatibility contract.
Keep commands thin and capability packages cohesive.
Reuse existing helpers and dependencies.
Keep durable local formats inspectable and versioned.
Preserve expstore as local truth.
Make retry, checkpoint, and partial-write behavior explicit.
Add tests at the owning layer.

External contract changes need external evidence. A manifest or telemetry change needs evidence beyond a utility unit test.

Make a compatible change

Mon, 01 Jan 0001 00:00:00 +0000

Start from the user path and compatibility contract.
Keep Cobra command files focused on wiring, flags, validation, and output.
Put reusable behavior in the owning internal/* capability package.
Preserve inspectable, versioned durable formats.
Keep expstore authoritative and hosted analytics downstream.
Test behavior at the layer that owns it.

Run focused package tests while iterating. Before TauGrid-internal closeout:

cd cli
go test ./...

Manifest, runtime, telemetry, or Kubernetes lifecycle changes also require the smallest safe end-to-end path that proves the external contract. Use the Kind smoke test when the changed contract belongs to the portable Kubernetes path.

Run the Kind smoke test

Mon, 01 Jan 0001 00:00:00 +0000

Use this contributor smoke test for changes to manifest rendering, submission, Kueue admission, KubeRay lifecycle handling, or the portable Kubernetes path. Kind supplies a disposable local Kubernetes API and Nodes for portable-path validation, distinct from an AKS or provider-integration acceptance test.

From the repository root, local dry-run verifies the checked-in fixture and rendering contracts entirely offline, with no cluster required:

make -C cli build
cli/bin/tau run validate --config examples/kind-smoke/tau.yaml
cli/bin/tau run --config examples/kind-smoke/tau.yaml --dry-run=client

The full smoke test requires Kind, kubectl, Helm, and a healthy Docker or Podman engine with at least 8 GiB of memory. Run:

Releasing TauGrid

Mon, 01 Jan 0001 00:00:00 +0000

TauGrid release preparation updates:

SDK version.
Installation documentation.
cli/releases/vX.Y.Z.md.
The reviewed source commit on main.

Maintainers then create an annotated SemVer tag and manually dispatch the release workflow. The workflow builds twice, compares outputs, verifies checksums, publishes immutable assets, and proves clean bootstrap.

Never overwrite an existing release or asset. Do not update downstream minimum versions until post-publication Ubuntu and macOS verification succeeds.

Follow the exact RELEASING.md checklist.

Site and wiki parity

Mon, 01 Jan 0001 00:00:00 +0000

The TauGrid documentation site and GitHub Wiki are both maintained as complete surfaces. They are edited separately, so semantic parity is a human ownership responsibility rather than an automated synchronization claim.

site/data/wiki-parity.toml records:

The maintained site page and wiki counterpart.
The owning team.
Current maturity.
Last joint review date.

The documentation pipeline validates that mapped site pages exist and metadata is current whenever the site changes. Its consolidated Azure DevOps pipeline also runs the same parity and review-age checks on the Monday parity-only schedule.