Skip to content

Add CONTRIBUTING section to README #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
niteshift-dev-staging wants to merge 1 commit into from
Closed

Add CONTRIBUTING section to README #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
Loading