doc: update docs with feedback on PR#1

- Add CLA and community guidelines to CONTRIBUTING.md
- Rename workflows
- Remove e2e tests from workflows
- Clarify difference from tetratelabs/proxy-wasm-go-sdk

Signed-off-by: Matt Leon <mattleon@google.com>

Author: leonm1

.github/workflows/workflow.yaml

@@ -1,11 +1,16 @@
-name: Test
+name: SDK Workflows
 on:
   pull_request:
     branches:
       - main
   push:
     branches:
       - main
+  schedule:
+    - cron: '0 0 * * *'
+
+env:
+  GO_VERSION: go1.24rc1
 
 jobs:
   style:
@@ -15,7 +20,7 @@ jobs:
       - name: install Go
         uses: actions/setup-go@v5
         with:
-          go-version: 'go1.24rc1'
+          go-version: {{ env.GO_VERSION }}
 
       - name: checkout
         uses: actions/checkout@v3
@@ -33,7 +38,7 @@ jobs:
       - name: install Go
         uses: actions/setup-go@v5
         with:
-          go-version: 'go1.24rc1'
+          go-version: {{ env.GO_VERSION }}
 
       - name: checkout
         uses: actions/checkout@v3
@@ -42,27 +47,7 @@ jobs:
         run: make test
 
   examples:
-    name: Examples (${{ matrix.envoy-image }})
-    strategy:
-      fail-fast: false
-      matrix:
-        envoy-image: [
-          "envoyproxy/envoy-dev:latest",
-          "envoyproxy/envoy:v1.24-latest",
-          "envoyproxy/envoy:v1.25-latest",
-          "envoyproxy/envoy:v1.26-latest",
-          "envoyproxy/envoy:v1.27-latest",
-          "envoyproxy/envoy:v1.28-latest",
-          "envoyproxy/envoy:v1.29-latest",
-          "envoyproxy/envoy:v1.30-latest",
-          "istio/proxyv2:1.16.0",
-          "istio/proxyv2:1.17.0",
-          "istio/proxyv2:1.18.0",
-          "istio/proxyv2:1.19.0",
-          "istio/proxyv2:1.20.0",
-          "istio/proxyv2:1.21.0",
-          "istio/proxyv2:1.22.0",
-        ]
+    name: Examples Tests
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -72,30 +57,17 @@ jobs:
         uses: actions/cache@v3
         with:
           path: |
-            ~/.cache/go-build
-            ~/.cache/tinygo
             ~/go/pkg/mod
             ~/go/bin
-          key: examples-${{ hashFiles('**/go.mod', '**/go.sum') }}-v${{ env.TINYGO_VERSION }}
+          key: examples-${{ hashFiles('**/go.mod', '**/go.sum') }}-{{ env.GO_VERSION }}
 
       - name: Install Go
         uses: actions/setup-go@v5
         with:
-          go-version: 'go1.24rc1'
+          go-version: {{ env.GO_VERSION }}
 
       - name: Build examples
         run: make build.examples
 
       - name: Test examples
         run: make test.examples
-
-      - name: Install Envoy
-        run: |
-          export ENVOY_BIN_DIR=$HOME/envoy/bin
-          mkdir -p $ENVOY_BIN_DIR
-          docker run -v $ENVOY_BIN_DIR:/tmp/proxy-wasm-go-sdk -w /tmp/proxy-wasm-go-sdk \
-            --entrypoint /bin/cp ${{ matrix.envoy-image }} /usr/local/bin/envoy .
-          echo $ENVOY_BIN_DIR >> $GITHUB_PATH
-
-      - name: Run e2e test
-        run: make test.e2e

README.md

@@ -3,6 +3,8 @@
 The Go SDK for
  [Proxy-Wasm](https://github.com/proxy-wasm/spec), enabling developers to write Proxy-Wasm plugins in Go. 
 
+Note: This SDK targets the upstream Go compiler, version 1.24 or later. This is different than the forked github.com/tetratelabs/proxy-wasm-go-sdk, which targets the TinyGo compiler.
+
 ## Project Status
 
 This SDK is based off of github.com/tetratelabs/proxy-wasm-go-sdk; however, it is effectively a new SDK targeting a completely different toolchain. It relies on the not-yet-released Go 1.24 and hasn't seen extensive prod testing by end-users. This SDK is an alpha product.
@@ -14,7 +16,8 @@ This SDK is based off of github.com/tetratelabs/proxy-wasm-go-sdk; however, it i
 
 ## Requirements
 
-- \[Required] [Go](https://go.dev/): v1.24+ - This SDK leverages Go 1.24's support for [WASI](https://github.com/WebAssembly/WASI) (WebAssembly System Interface) reactors. You can grab a release candidate from the [Go unstable releases page](https://go.dev/dl/#unstable).
+- \[Required] [Go](https://go.dev/): v1.24+ - This SDK leverages Go 1.24's support for [WASI](https://github.com/WebAssembly/WASI) (WebAssembly System Interface) reactors. You can grab a release candidate from the [Go unstable releases page](https://go.dev/dl/#unstable). A stable release of Go 1.24 is [expected in February 2025](https://tip.golang.org/doc/go1.24).
+- \[Required] A host environment supporting this toolchain - This SDK leverages additional host imports added to the proxy-wasm-cpp-host in [PR#427](https://github.com/proxy-wasm/proxy-wasm-cpp-host/pull/427). This has yet to be merged, let alone make its way downstream to Envoy, ATS, nginx, or managed environments.
 - \[Optional] [Envoy](https://www.envoyproxy.io) - To run end-to-end tests, you need to have an Envoy binary. You can use [func-e](https://func-e.io) as an easy way to get started with Envoy or follow [the official instruction](https://www.envoyproxy.io/docs/envoy/latest/start/install).
 
 ## Installation
@@ -25,7 +28,7 @@ go get github.com/proxy-wasm/proxy-wasm-go-sdk
 
 ## Minimal Example Plugin
 
-A minimal plugin 
+A minimal plugin:
 
 ```go
 package main
@@ -58,10 +61,15 @@ It can be compiled with `env GOOS=wasip1 GOARCH=wasm go build -buildmode=c-share
 # Build all examples.
 make build.examples
 
-# Build a specific example.
-make build.example name=helloworld
+# Build a specific example using the `go` tool.
+cd examples/helloworld
+env GOOS=wasp1 GOARCH=wasm go build -buildmode=c-shared -o main.wasm main.go
+
+# Test the built wasm module using `go test`.
+go test
 
-# Run a specific example.
+# Build and test a specific example from the repo root using `make`.
+make build.example name=helloworld
 make run name=helloworld
 ```
 
@@ -85,6 +93,6 @@ We welcome contributions from the community! See [CONTRIBUTING.md](doc/CONTRIBUT
 ## External links
 
 - [WebAssembly for Proxies (ABI specification)](https://github.com/proxy-wasm/spec)
-- [WebAssembly for Proxies (AssemblyScript SDK)](https://github.com/solo-io/proxy-runtime)
 - [WebAssembly for Proxies (C++ SDK)](https://github.com/proxy-wasm/proxy-wasm-cpp-sdk)
 - [WebAssembly for Proxies (Rust SDK)](https://github.com/proxy-wasm/proxy-wasm-rust-sdk)
+- [WebAssembly for Proxies (AssemblyScript SDK)](https://github.com/solo-io/proxy-runtime)

doc/CONTRIBUTING.md

@@ -21,16 +21,26 @@ make test.e2e
 make test.e2e.single name=helloworld
 ```
 
-## Code Reviews
-
-* Indicate the priority of each comment, following this
-[feedback ladder](https://www.netlify.com/blog/2020/03/05/feedback-ladders-how-we-encode-code-reviews-at-netlify/).
-If none was indicated it will be treated as `[dust]`.
-* A single approval is sufficient to merge, except when the change cuts
-across several components; then it should be approved by at least one owner
-of each component. If a reviewer asks for changes in a PR they should be
-addressed before the PR is merged, even if another reviewer has already
-approved the PR.
-* During the review, address the comments and commit the changes _without_ squashing the commits.
-This facilitates incremental reviews since the reviewer does not go through all the code again to
-find out what has changed since the last review.
+## Contributor License Agreement
+
+Contributions to this project must be accompanied by a Contributor License
+Agreement. You (or your employer) retain the copyright to your contribution;
+this simply gives us permission to use and redistribute your contributions as
+part of the project. Head over to <https://cla.developers.google.com/> to see
+your current agreements on file or to sign a new one.
+
+You generally only need to submit a CLA once, so if you've already submitted one
+(even if it was for a different project), you probably don't need to do it
+again.
+
+## Code reviews
+
+All submissions, including submissions by project members, require review. We
+use GitHub pull requests for this purpose. Consult
+[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
+information on using pull requests.
+
+## Community Guidelines
+
+This project follows [Google's Open Source Community
+Guidelines](https://opensource.google/conduct/).