Repository navigation
DOC: update contributing guide to reflect the preferred practice #186
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?
Activity
bsipocz commentedon Jun 28, 2023
Maybe we can write this contributing guide in a generic way that can be reused elsewhere, too?
@rossbar: I suppose the preferred workflow is the same for the nx-guides?
ankur0904 commentedon Nov 9, 2023
@bsipocz I want to work on this issue.
rossbar commentedon Nov 9, 2023
Thanks for your interest @ankur0904 - generally speaking this is probably not a great "first issue" as it deals mostly with documenting developer workflow as opposed to the tutorials themselves. If you're generally looking for ways to improve the tutorials, something like #152 would be great as it deals with improving user-facing tutorial content!
ankur0904 commentedon Nov 10, 2023
@rossbar Thanks for the suggestion. I must look into #152