Review of Episodes 1 - 2: Fair Software and Tools and Practices

[kkh451]

Minor edits and suggestions after reviewing episodes 1-2:

01-fair-research-software.md:

• Minor edits for clarity and flow (or typos)
• Add some missing links that were not rendering

02-tools.md

• Minor edits for clarity and flow (or typos)
• Add some suggestions for further reading

[github-actions[bot]]

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:

• :dart: correct output
• :framed_picture: correct figures
• :question: new warnings
• :bangbang: new errors

Rendered Changes

:mag: Inspect the changes: https://github.com/carpentries-incubator/fair-research-software/compare/md-outputs..md-outputs-PR-81

The following changes were observed in the rendered markdown documents:

 01-fair-research-software.md |  8 ++++----
 02-tools.md                  | 13 +++++++------
 links.md                     |  5 +++++
 md5sum.txt                   |  6 +++---
 4 files changed, 19 insertions(+), 13 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-29 16:02:13 +0000

[anenadic]

Many thanks @kkh451