d54227e8b5
* Update pull_request_template.md * Update pull_request_template.md * consistent case * remove mention of large binary files this should be handled via automation and isn't tied to the docs site, but instead to git repo management
2.3 KiB
2.3 KiB
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)
- New example for the documentation site (Linked from a discoverable page, e.g. via the sidebar in
- Example updates (Bug fixes, new features, etc.)
- Other (changes to the codebase, but not to examples)
Documentation Site Checklist
☑️ Monitoring
- Example is configured for testing in the synthetic monitoring system
- Example is tested by executing with
modal run, or an alternativecmdis provided in the example frontmatter (e.g.cmd: ["modal", "serve"]) - Example is tested by running the
cmdwith no arguments, or theargsare provided in the example frontmatter (e.g.args: ["--prompt", "Formula for room temperature superconductor:"] - Example does not require third-party dependencies besides
fastapito be installed locally (e.g. does not importrequestsortorchin the global scope or in the scope of alocal_entrypoint)
- Example is tested by executing with
☑️ Content
- Example is documented with comments throughout, in a Literate Programming style
- Example media assets 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 likelatest - Example specifies a
python_versionfor the base image, if it is used - Example pins all dependencies to at least SemVer minor version,
~=x.y.zor==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 < 1are pinned to patch version,==0.y.z
- Example dependencies with
- Example pins container images to a stable tag like
Outside Contributors
You're great! Thanks for your contribution.