From e4eb38d02177541f4dec5b399c33d7f9ebf84ef6 Mon Sep 17 00:00:00 2001 From: Yann Date: Sat, 25 Jul 2026 20:11:17 +0000 Subject: [PATCH] Add CONTRIBUTING section to README with test suite instructions Run-on: Niteshift Preview --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index c862dd90..711d895b 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,15 @@ For more details, documentation and installation instructions, see the README fo - **[JavaScript / TypeScript](./modal-js/README.md)** - **[Go](./modal-go/README.md)** +## Contributing + +Both SDKs run integration tests against a real Modal workspace, so you'll need Modal API credentials (`MODAL_TOKEN_ID` and `MODAL_TOKEN_SECRET`) exported in your environment before running the test suites locally. + +- **JavaScript / TypeScript**: from `modal-js/`, run `npm ci` once, then `npm test`. +- **Go**: from `modal-go/`, run `go test ./...`. + +See the [CI workflow](./.github/workflows/ci.yaml) for the exact commands and setup used on pull requests. + ## Support For usage questions and other support, please reach out on the [Modal Community Slack](https://modal.com/slack).