search

carpentries-incubator / managing-computational-projects

Managing Open and Reproducible Computational Projects
https://carpentries-incubator.github.io/managing-computational-projects
Other
10 stars 10 forks source link

Workbench changes #89

Closed jcolomb closed 1 year ago

github-actions[bot] commented 1 year 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/managing-computational-projects/compare/md-outputs..md-outputs-PR-89

The following changes were observed in the rendered markdown documents:

 index.md   | 1 -
 md5sum.txt | 2 +-
 2 files changed, 1 insertion(+), 2 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 2023-03-22 08:00:08 +0000

jcolomb commented 1 year ago

or should we add another way to make comments ?

tobyhodges commented 1 year ago

Here's a nice example of a README being updated after transition to the Workbench: https://github.com/datacarpentry/r-raster-vector-geospatial/pull/382

jcolomb commented 1 year ago

Here's a nice example of a README being updated after transition to the Workbench: https://github.com/datacarpentry/r-raster-vector-geospatial/pull/382

both there and here, the best would be to have an updated contributing.md file, is there any in the template ?

zkamvar commented 1 year ago

Here's a nice example of a README being updated after transition to the Workbench: datacarpentry/r-raster-vector-geospatial#382

both there and here, the best would be to have an updated contributing.md file, is there any in the template ?

Why yes there is! It's here: https://github.com/carpentries/sandpaper/blob/main/inst/templates/contributing-template.txt

... uhm this is embarassing. I have not actually done anything to update it from the former template -_-. I'm currently battling a particularly nasty bug (https://github.com/carpentries/sandpaper/issues/406) and I will do my best to update it when I get time.

jcolomb commented 1 year ago

ok tried to make some changes at https://github.com/carpentries/sandpaper/pull/407

will probably be make changes there and update here using some sandpaper function, right?

zkamvar commented 1 year ago

will probably be make changes there and update here using some sandpaper function, right?

The update will be copy/paste since this is a markdown file that {sandpaper} only touches at the creation of the lesson.