Skip to content

DOC: update contributing guide to reflect the preferred practice #186

@bsipocz

Description

@bsipocz
Member

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?

Activity

added
documentationImprovements or additions to documentation
infrastructureIssues relevant to infrasructure, rather than content
on Jun 28, 2023
bsipocz

bsipocz commented on Jun 28, 2023

@bsipocz
MemberAuthor

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

ankur0904 commented on Nov 9, 2023

@ankur0904

@bsipocz I want to work on this issue.

rossbar

rossbar commented on Nov 9, 2023

@rossbar
Collaborator

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

ankur0904 commented on Nov 10, 2023

@ankur0904

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationinfrastructureIssues relevant to infrasructure, rather than content

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @rossbar@bsipocz@ankur0904

        Issue actions

          DOC: update contributing guide to reflect the preferred practice · Issue #186 · numpy/numpy-tutorials