Skip to content

Commit

Permalink
Documents frontmatter fields and dependency pinning
Browse files Browse the repository at this point in the history
Clarifying the use of some of the frontmatter fields, elaborating the dependency-pinning practices
  • Loading branch information
charlesfrye authored Mar 4, 2024
1 parent c2f0295 commit 76a9839
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,16 @@

## Checklist

- [ ] Example is testable in synthetic monitoring system, or `lambda-test: false` is added to example frontmatter
- [ ] Example does _not_ require third-party dependencies to be installed locally
- [ ] Example pins all dependencies
- [ ] Example dependencies with `version < 1` are pinned to minor version, `==0.x.y`
- [ ] Example specifies a `python_version` for the base image
- [ ] Example is testable in synthetic monitoring system, or `lambda-test: false` is added to example frontmatter (`---`)
- [ ] Example is tested by executing with `modal run` or an alternative `cmd` is provided in the example frontmatter (e.g. `cmd: ["modal", "deploy"]`)
- [ ] Example is tested by running with no arguments or the `args` are provided in the example frontmatter (e.g. `args: ["--prompt", "Formula for room temperature superconductor:"]`
- [ ] Example is documented with comments throughout, in a [_Literate Programming_](https://en.wikipedia.org/wiki/Literate_programming) style.
- [ ] Example does _not_ require third-party dependencies to be installed locally
- [ ] Example pins its dependencies
- [ ] Example pins container images to a stable tag, 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 minor version, `~=x.y.z` or `==x.y`
- [ ] Example dependencies with `version < 1` are pinned to patch version, `==0.y.z`

## Outside contributors

Expand Down

0 comments on commit 76a9839

Please sign in to comment.