ns-rse / git-collaboration

Intermediate level course on using Git for collaboration
https://ns-rse.github.io/git-collaboration/
Other
1 stars 0 forks source link

Git Hygiene #54

Closed ns-rse closed 3 months ago

ns-rse commented 3 months ago

Closes #18 Closes #21 Closes #22 Closes #48

Main body of git hygiene written, probably need to emphasise more how keeping things neat and tidy helps but many of the tasks are there.

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/ns-rse/git-collaboration/compare/md-outputs..md-outputs-PR-54

The following changes were observed in the rendered markdown documents:

 branching.md   |   2 +-
 git_hygiene.md | 814 ++++++++++++++++++++++++++++++++++++++++++++++++++++++---
 index.md       |   4 +-
 md5sum.txt     |   6 +-
 4 files changed, 781 insertions(+), 45 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-08 18:08:57 +0000