swcarpentry / r-novice-gapminder

R for Reproducible Scientific Analysis
http://swcarpentry.github.io/r-novice-gapminder/
Other
164 stars 538 forks source link

Suggestion for adding image examples for teaching hybrid lessons. In the Gapminder lesson for R, under the Control Flow, I have drawn on a whiteboard (in person) how a For Loop works. It would be awesome to have an image to share with those on zoom who can't seen the whiteboard drawings. #786

Open lorisloane opened 2 years ago

lorisloane commented 2 years ago
Instructions Thanks for contributing! :heart: If this contribution is for instructor training, please email the link to this contribution to checkout@carpentries.org so we can record your progress. You've completed your contribution step for instructor checkout by submitting this contribution! If this issue is about a specific episode within a lesson, please provide its link or filename. Keep in mind that **lesson maintainers are volunteers** and it may take them some time to respond to your contribution. Although not all contributions can be incorporated into the lesson materials, we appreciate your time and effort to improve the curriculum. If you have any questions about the lesson maintenance process or would like to volunteer your time as a contribution reviewer, please contact The Carpentries Team at team@carpentries.org. You may delete these instructions from your comment. \- The Carpentries

matthieu-bruneaux commented 2 years ago

Thank you for your suggestion @lorisloane. Adding one or several figures to support the content of this lesson could indeed be very helpful to the learners.

I am not sure what is the best way to discuss figures for the lessons: maybe @naupaka or @skanwal would have some good advice about this? Are pull requests a good way of discussing and reviewing graphical material or are other approaches recommended for those?

skanwal commented 2 years ago

Hi @matthieu-bruneaux and @lorisloane

Thanks for initiating the discussion.

Are pull requests a good way of discussing and reviewing graphical material or are other approaches recommended for those?

Yes, PR is indeed the right way to go for this. Concept for "Control flow" can indeed be better supported using a graphical image. It's worth adding if there doesn't exist one already.

matthieu-bruneaux commented 2 years ago

Thank you very much for your advice @skanwal!

@lorisloane, would you like to submit a pull request with an image to illustrate this concept? Please don't hesitate to let us know if we can help in any way :)

It might also be the case that a relevant image already exists in another of the Carpentries lessons, in which case an option could be to re-use it for this lesson too.

lorisloane commented 2 years ago

Greetings,

I’m not sure what a “pull request” is. Where do I find out more?

This is the type of diagram that I’m referring too: @.*** Image from: https://www.codingem.com/flowchart-loop/

-lori

From: Matthieu Bruneaux @.> Sent: Tuesday, August 2, 2022 2:49 PM To: swcarpentry/r-novice-gapminder @.> Cc: Lori D Sloane @.>; Mention @.> Subject: Re: [swcarpentry/r-novice-gapminder] Suggestion for adding image examples for teaching hybrid lessons. In the Gapminder lesson for R, under the Control Flow, I have drawn on a whiteboard (in person) how a For Loop works. It would be awesome to have an...

[[-- External - this message has been sent from outside the University --]]

Thank you very much for your advice @skanwalhttps://urldefense.com/v3/__https:/github.com/skanwal__;!!KXH1hvEXyw!df674yV_UgzdcqJFjUGUeSLG3uNKxgnR7dEVjxpmRIWh2oOKgKLkgTE4lRQuUzePf4CkzawMLwjTzw2xHU5ytABA_Q$!

@lorisloanehttps://urldefense.com/v3/__https:/github.com/lorisloane__;!!KXH1hvEXyw!df674yV_UgzdcqJFjUGUeSLG3uNKxgnR7dEVjxpmRIWh2oOKgKLkgTE4lRQuUzePf4CkzawMLwjTzw2xHU7AOWioBg$, would you like to submit a pull request with an image to illustrate this concept? Please don't hesitate to let us know if we can help in any way :)

It might also be the case that a relevant image already exists in another of the Carpentries lessons, in which case an option could be to re-use it for this lesson too.

— Reply to this email directly, view it on GitHubhttps://urldefense.com/v3/__https:/github.com/swcarpentry/r-novice-gapminder/issues/786*issuecomment-1203200354__;Iw!!KXH1hvEXyw!df674yV_UgzdcqJFjUGUeSLG3uNKxgnR7dEVjxpmRIWh2oOKgKLkgTE4lRQuUzePf4CkzawMLwjTzw2xHU5qv5Pojw$, or unsubscribehttps://urldefense.com/v3/__https:/github.com/notifications/unsubscribe-auth/ABLLVYFIKGONTN3FAIXMAWTVXGCT7ANCNFSM5XZXBAAA__;!!KXH1hvEXyw!df674yV_UgzdcqJFjUGUeSLG3uNKxgnR7dEVjxpmRIWh2oOKgKLkgTE4lRQuUzePf4CkzawMLwjTzw2xHU7FAdFBBA$. You are receiving this because you were mentioned.Message ID: @.**@.>>

matthieu-bruneaux commented 2 years ago

Hi @lorisloane!

Thank you for the link to the diagrams you had in mind, this is very helpful.

On GitHub, a "pull request" is when someone who wants to contribute to a Git repository has made a personal copy of this repository (a "fork"), then has made some changes to their copy (they saved some "commits"), and finally they ask the maintainers of the original repository to merge their changes into the original repository (this is the "pull request"). The maintainers review the "pull request" and can accept or reject it, or ask for some modifications.

If you are not familiar with Git, GitHub, and/or pull requests, it is of course not a problem at all :) Opening a new issue like you did and participating in the discussion is extremely helpful and is a great way to contribute to the Software Carpentry lessons, and others contributors can then join in and help for the edits.

If you would like to learn more about Git/GitHub/pull requests (I am not sure how familiar you are with any/some of those), some good resources are:

In any case, if nobody else submits a pull request within a few days, then I will probably have some time soon to prepare one myself and I will be able to use the link you shared as a reference.

Feel free to let us know if you have any questions :)