search

carpentries / instructor-training

Instructor Training
https://carpentries.github.io/instructor-training/
Other
175 stars 290 forks source link

clarify welcome step, closes #1677 #1678

Closed brownsarahm closed 3 months ago

brownsarahm commented 3 months ago

I want to also confirm that this is the way that we want the policy stated, so tagging @carpentries/trainers-leadership for confirmation

github-actions[bot] commented 3 months ago

Thank you!

Thank you for your pull request :smiley:

:robot: This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

Rendered Changes

:mag: Inspect the changes: https://github.com/carpentries/instructor-training/compare/md-outputs..md-outputs-PR-1678

The following changes were observed in the rendered markdown documents:

 checkout.md | 6 ++++--
 md5sum.txt  | 2 +-
 2 files changed, 5 insertions(+), 3 deletions(-)
What does this mean? If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible. This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

:stopwatch: Updated at 2024-06-19 16:56:23 +0000

ragamouf commented 3 months ago

Yes, I support this clarification. Good move!

jonathanwheeler01 commented 3 months ago

Yes, thank you. This is a helpful addition.

ndporter commented 3 months ago

Agreed with others - this looks good. Thanks @brownsarahm