Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
bsipocz opened this issue Jun 28, 2023 · 4 comments
Open

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

bsipocz opened this issue Jun 28, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation infrastructure Issues relevant to infrasructure, rather than content

Comments

@bsipocz
Copy link
Member

bsipocz commented Jun 28, 2023

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 bsipocz added documentation Improvements or additions to documentation infrastructure Issues relevant to infrasructure, rather than content labels Jun 28, 2023
@bsipocz
Copy link
Member Author

bsipocz commented 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
Copy link

@bsipocz I want to work on this issue.

@rossbar
Copy link
Collaborator

rossbar commented 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
Copy link

@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
Labels
documentation Improvements or additions to documentation infrastructure Issues relevant to infrasructure, rather than content
Projects
None yet
Development

No branches or pull requests

3 participants