Skip to content

Commit

Permalink
update contributing text
Browse files Browse the repository at this point in the history
  • Loading branch information
jeffjennings authored Oct 9, 2024
1 parent 3a5efea commit 8af29e2
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/contributing/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Each tutorial is a [Jupyter notebook](https://jupyter.org/) file. Each notebook

### Template intro

The first cell in every tutorial notebook is a markdown cell used for the title, author list, keywords, and summary. It should adhere to the following format:
The first cell in every tutorial notebook is a markdown cell used for the title, author list, keywords, and summary. All of this information should be contained in a single cell and should adhere to the following format:

```
# Title name
Expand All @@ -44,7 +44,7 @@ In this tutorial, we will download a data file, do something to it, and then
visualize it.
```

The second cell in every tutorial notebook is a code cell used to display required packages for users, and should be the following lines (this expects the `requirements.txt` file in the notebook's directory with a list of required packages to be present):
The second cell in every tutorial notebook is a code cell used to display required packages for users, and should be the following lines (this expects the `requirements.txt` file to be present in the notebook's directory):

```
with open('requirements.txt') as f:
Expand Down

0 comments on commit 8af29e2

Please sign in to comment.