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

Add refactoring steps to Version Control and Code Readability episodes #99

Closed kkh451 closed 1 week ago

kkh451 commented 1 week ago

This pull request relies on the following other pull requests:

  1. Updated Good Code (removes content not covered in the course and updates the dataset to a format that works with both good and bad code [the update to the dataset is essential for the testing episode)

https://github.com/carpentries-incubator/astronout-data-analysis-fair/pull/3

  1. Update the starting point for the bad code and update the dataset to one that can be used by good and bad code:

https://github.com/carpentries-incubator/astronaut-data-analysis-not-so-good/pull/8

  1. Update the end of episode code status checkpoints for version control and code readability: https://github.com/carpentries-incubator/astronaut-data-analysis-not-so-good/pull/10 https://github.com/carpentries-incubator/astronaut-data-analysis-not-so-good/pull/9
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-99

The following changes were observed in the rendered markdown documents:

 03-version-control.md  | 295 +++++++++++++++++++++++++++++++++++++++++++++++
 04-code-readability.md | 306 +++++++++++++++++++++++++++++++++++++++++++------
 links.md               |   1 +
 md5sum.txt             |   6 +-
 4 files changed, 567 insertions(+), 41 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-30 18:44:23 +0000