carpentries-incubator / fair-research-software

A course on tools and practices for open, sustainable and FAIR (Findable, Accessible, Interoperable and Reusable) research software
https://carpentries-incubator.github.io/fair-research-software/
Other
10 stars 5 forks source link

Initial draft of intro episode #22

Closed anenadic closed 5 months ago

anenadic commented 6 months ago

Unfinished first draft of an intro episode - it is missing the explanation of the example data and software project we will be using in exercises and possible a jargon busting section.

It may overlap with the FAIR things @SJaffa may want to mention in her episode on FAIR software so things may move around.

Early feedback welcome!

github-actions[bot] commented 6 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-incubator/fair-research-software/compare/md-outputs..md-outputs-PR-22

The following changes were observed in the rendered markdown documents:

 00-introduction.md           | 176 ++++++++++++++++++++++++++++++++++++++++++-
 01-fair-research-software.md |   2 +-
 md5sum.txt                   |   4 +-
 3 files changed, 177 insertions(+), 5 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-03-01 15:54:35 +0000

anenadic commented 6 months ago

Added jargon/terminology section and explanation of "reproducible" research as per the Turing Way project's guide.

anenadic commented 6 months ago

Ready for review - would anyone like to provide some comments please @kkh451 @SJaffa @colinsauze @sgibson91 ?

anenadic commented 5 months ago

Had a conversation with @SJaffa on 2024-03-01 where we agreed how to split this episode to merge this PR - see discussion in #23.