DOC: update contributing guide to reflect the preferred practice
Open
Nobody has claimed this yet.
documentation
infrastructure
- Dominant language
- No language data
- Stars
- 673
- Forks
- 229
- PR merge metrics
- No merged PRs in 30d
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?
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
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.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100