modal-examples/.github/pull_request_template.md

Type of Change

• New example for the GitHub repo
  • New example for the documentation site (Linked from a discoverable page, e.g. via the sidebar in /docs/examples)
• Example updates (Bug fixes, new features, etc.)
• Other (Changes to the codebase, but not to examples)

Monitoring Checklist

• Example is configured for testing in the synthetic monitoring system, or lambda-test: false is provided in the example frontmatter and I have gotten approval from a maintainer
  • Example is tested by executing with modal run, or an alternative cmd is provided in the example frontmatter (e.g. cmd: ["modal", "serve"])
  • Example is tested by running the cmd with no arguments, or the args are provided in the example frontmatter (e.g. args: ["--prompt", "Formula for room temperature superconductor:"]
  • Example does not require third-party dependencies besides fastapi to be installed locally (e.g. does not import requests or torch in the global scope or other code executed locally)

Documentation Site Checklist

Content

• Example is documented with comments throughout, in a Literate Programming style
• All media assets for the example that are rendered in the documentation site page are retrieved from modal-cdn.com

Build Stability

• Example pins all dependencies in container images
  • Example pins container images to a stable tag like v1, not a dynamic tag like latest
  • Example specifies a python_version for the base image, if it is used
  • Example pins all dependencies to at least SemVer minor version, ~=x.y.z or ==x.y, or we expect this example to work across major versions of the dependency and are committed to maintenance across those versions
    • Example dependencies with version < 1 are pinned to patch version, ==0.y.z

Outside Contributors

You're great! Thanks for your contribution.