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
7 stars 4 forks source link

Review of episodes 3 - 4: Version Control and Code Readability #91

Closed kkh451 closed 1 week ago

kkh451 commented 1 week ago

03-version-control:

The following unresolved issues are noted:

04-code-readability

The following unresolved issues are noted:

github-actions[bot] commented 1 week 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-91

The following changes were observed in the rendered markdown documents:

 03-version-control.md  |  31 ++++----
 04-code-readability.md | 204 ++++++++++++++++++++-----------------------------
 links.md               |   4 +-
 md5sum.txt             |   6 +-
 4 files changed, 106 insertions(+), 139 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:08:39 +0000