The-Strategy-Unit / The-Strategy-Unit/data_science

Add to "how we work" to use nbdev if using Jupyter notebooks

Open
#330 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
11
Forks
5
Avg merge
5h 34m
Merged PRs (30d)
1

Description

Jupyter notebooks are to be avoided if possible but they are a convenient and sometimes necessary evil. There are tools which can help make them more git-friendly; add this info to "how we work".

https://nbdev.fast.ai/tutorials/git_friendly_jupyter.html
https://github.com/kynan/nbstripout

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the project's "how we work" documentation and review the linked nbdev Git-friendly Jupyter guide and nbstripout project. Done means the document explains how to make Jupyter notebooks more suitable for version control and includes the relevant links.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.