Skip to content

Commit a6fe992

Browse files
authored
Merge pull request #8 from marimo-team/aka/contribution-checklist
Update contribution checklist
2 parents 243af5e + fee28d7 commit a6fe992

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,6 @@ If this PR fixes any issues, list them here by number (e.g., Fixes #123).
1515

1616
- [ ] I have included package dependencies in the notebook file [using `--sandbox`](https://docs.marimo.io/guides/package_reproducibility/)
1717
- [ ] I have included a short README.md describing my example and how to run it.
18+
- [ ] I have included instructions on how to adapt the notebook to custom data and models
1819
- [ ] I have included an ["Open in marimo" badge](https://docs.marimo.io/guides/publishing/playground/#open-notebooks-hosted-on-github) in the README if my example works in [WASM](https://docs.marimo.io/guides/wasm/).
19-
- [ ] If my notebook accesses local files, I used [`mo.notebook_location()`](https://docs.marimo.io/api/miscellaneous/?h=notebook_location#marimo.notebook_location) to construct notebook paths
20+
- [ ] If my notebook accesses local files, I used [`mo.notebook_directory()`](https://docs.marimo.io/api/miscellaneous/?h=notebook_directory#marimo.notebook_directory) to construct notebook paths

README.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,14 @@ the "open in marimo" badge in its README.
2323
We welcome community contributions of examples; you don't need to be
2424
an expert to help out!
2525

26-
Open a pull request to contribute a new example. Each example should be placed
27-
in its own folder and include a short `README.md`. We also include smoke tests
28-
for each notebook in `tests/`. Run tests with `uvx --with marimo pytest .`
26+
Open a pull request to contribute a new example. Ideally, examples are easy
27+
for others to adapt to their own data and models. Here's a contribution checklist:
28+
29+
- [ ] Place the example in its own folder
30+
- [ ] Include package dependencies in notebook files [using
31+
`--sandbox`](https://docs.marimo.io/guides/package_reproducibility/)
32+
- [ ] Include a short README.md describing your example and how to run it.
33+
- [ ] Include instructions on how to adapt the notebook to custom data and models
2934

3035
Looking for a specific example or template but can't find it? Feel free
3136
to file an issue and request it!

0 commit comments

Comments
 (0)