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
add "Open Science" and "Citation" notes #600
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @railyards! Thank you so much for the PR improving the instructor guide, especially for these later lessons. I really like what you've added about open science, including the comment suggesting instructors include some personal examples.
I think that the citation lesson sentence could be improved by either mentioning how citations relate to licensing, or, alternatively, mentioning that it's beneficial to make one's code easily citable by including citation files like the ones that are mentioned in the lesson. Would you mind updating your PR to reflect this?
_extras/guide.md
Outdated
@@ -274,6 +281,8 @@ their breath after what is often a frustrating couple of hours. | |||
|
|||
## [Citation]({{ page.root }}/12-citation/) | |||
|
|||
We teach about citation because it is important to give learners the tools to respect the licensing chosen for the code. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think mentioning licensing here (especially because it comes right after the licensing lesson) is a little confusing. I think it could be clearer by talking about how licensing relates to citations.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@munkm Since this was starting to go stale, I resolved the conflicts with the recent style update, and made your suggested changes to the content. Let me know what you think.
Made suggested changes.
I'm going to close this because changes requested by maintainers were never implemented, and PR appears abandoned. Please feel free to reopen or submit a new PR with requested changes (latter preferable as it resolves conflicts, and allow author to take into account any changes to the lesson text since this PR). |
Add instructor notes for Open Science and Citation.
These two sections were empty. The notes aim to help the instructor now why it is important to teach this content.