numpy-tutorials icon indicating copy to clipboard operation
numpy-tutorials copied to clipboard

DOC: update contributing guide to reflect the preferred practice

Open bsipocz opened this issue 2 years ago • 4 comments

Currently missing points:

  • No outputs should be included in the notebooks
  • we do prefer .md files 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?

bsipocz avatar Jun 28 '23 17:06 bsipocz

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?

bsipocz avatar Jun 28 '23 18:06 bsipocz

@bsipocz I want to work on this issue.

ankur0904 avatar Nov 09 '23 18:11 ankur0904

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!

rossbar avatar Nov 09 '23 21:11 rossbar

@rossbar Thanks for the suggestion. I must look into #152

ankur0904 avatar Nov 10 '23 17:11 ankur0904