Skip to content

Commit a1e3edd

Browse files
authored
Create Tutorials README.md
1 parent 692ac16 commit a1e3edd

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

tutorials/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Tutorial Creation Guidelines
2+
3+
We are super excited to see new tutorials and playground coming in from our community!
4+
5+
6+
Here are the guidelines for tutorial creation, which we kindly ask to adhere to:
7+
- For every tutorial, please create a subfolder
8+
- Add all necessary dependencies to the `requirements.txt` in this folder, which are not in the `pandaset` python package. We would like to keep the Devkit dependencies _lean_, but can add anything we need to the tutorial requirements.txt
9+
- If you think your code contains methods that should rather be part of the data set objects from the Devkit, feel free to add a PR for it, too, so we can review and decide where to best place it.
10+
- Add markdown cells between code cells, or at least use code comments so that everyone in the community can follow your steps.
11+
12+
13+
If you have other tutorials with other dependencies or build systems (for ex: Docker), feel free to include them in your tutorial's subfolder including a README.md for build instructions.
14+
15+

0 commit comments

Comments
 (0)