Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
87 lines (64 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

87 lines (64 loc) · 2.42 KB
Raw

Contributing

GOWDK is experimental compiler and runtime infrastructure. Keep changes focused, verified, and aligned with the compile-first product direction.

Prerequisites

  • Go 1.26.4 or the version declared by go.mod.
  • Node.js when checking the VS Code extension or browser-runtime tests.
  • VS Code 1.85 or newer when testing the extension manually.

Before Editing

Read the documents that own the changed surface:

  1. README
  2. Documentation Hub
  3. Product Vision
  4. Product Requirements
  5. Product Roadmap
  6. Architecture
  7. The relevant skill under .agents/skills/

For features or broad changes, write or update a specification and implementation plan from .agents/templates/. Use an ADR for a decision that is expensive to reverse.

Workflow

  1. Make the smallest vertical slice that exercises the behavior.
  2. Title pull requests with Conventional Commits, such as feat(compiler): add route graph output or fix(runtime): preserve clicked submit button; release-please uses the squash title for changelog and release-note generation.
  3. Preserve unrelated user changes.
  4. Update tests, examples, docs, and status in the same change.
  5. Keep generated Go as adapter glue rather than application logic.
  6. Avoid new production dependencies unless the change documents the reason.
  7. Run focused checks first, then the relevant repository gates.
  8. Record commands that fail and the next action needed.

Verification

Baseline commands:

go test ./...
go build ./cmd/gowdk

Run all Go module tests when Go code, compiler behavior, runtime behavior, or nested modules change:

scripts/test-go-modules.sh

When editor files change:

node --check editors/vscode/extension.js

Format changed Go files with:

gofmt -w <files>

Documentation

Use the Documentation Hub to find the owning lane and Documentation Style for the authoring contract.

Documentation changes run:

scripts/check-docs-links.sh
scripts/check-docs-style.sh
scripts/check-removed-syntax.sh
scripts/check-doc-versions.sh

Update Product Requirements when capability status changes. Do not rely on an issue, plan, or chat history as the only source of current behavior.