DOC: update contributing guide to reflect the preferred practice
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Read the current contributing guide and README to see where notebook practices are documented. Update the guidance to state that notebooks should contain no outputs and that .md files are preferred over .ipynb; done means the chosen guide structure clearly reflects both points.
Written by the indexing model from the issue text.
Description
Currently missing points:
- No outputs should be included in the notebooks
- we do prefer
.mdfiles as opposed to.ipynb.
Maybe the updated guide should be in a separate file, and keep the absolute newcomer version, that we currently have, in the README?
- Dominant language
- No language data
- Stars
- 673
- Forks
- 229
- PR merge metrics
- No merged PRs in 30d
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.
More from numpy/numpy-tutorials
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 68/100
numpy/numpy-tutorials#228 ·
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
numpy/numpy-tutorials#150 · 2 comments ·
-
enhancement
Difficulty 3/5 1-2 days Newbie friendliness 45/100
numpy/numpy-tutorials#305 · 1 reaction ·
-
maintenance
Difficulty 4/5 3-5 days Newbie friendliness 48/100
numpy/numpy-tutorials#283 · 1 reaction ·
-
enhancement infrastructure maintenance
Difficulty 4/5 3-5 days Newbie friendliness 25/100
numpy/numpy-tutorials#280 · 5 comments ·
All issues in numpy/numpy-tutorials
Similar issues
-
triage
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
feature pydanty:is-working
Difficulty 1/5 Under an hour Newbie friendliness 88/100
pydantic/pydantic-ai#8647 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
:watch: Not Triaged dotnet-fsharp/svc
Difficulty 1/5 Under an hour Newbie friendliness 90/100