suggest adding more details to building new notebooks in contributing guide
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Jupyter Notebook
- Stars
- 16
- Forks
- 15
- Avg merge
- 1h 39m
- Merged PRs (30d)
- 6
Description
Bullet 4 in https://github.com/ioos/ioos_code_lab/blob/main/CONTRIBUTING.md#building-new-notebooks should include:
- High level guidance on creating a jupyter notebook. (Is there a reference we can drop in here?)
- details on what to do with large data
- if needed, details on HPC resources
- guidance on the content of markdown cells. Plain language description of what the code is doing.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open CONTRIBUTING.md and the “Building new notebooks” section, then inspect Bullet 4 and the surrounding guidance. Identify suitable references and document notebook creation, handling large data, HPC resources when needed, and plain-language content for markdown cells. Done means Bullet 4 covers all four requested areas.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100