astronomy-python icon indicating copy to clipboard operation
astronomy-python copied to clipboard

Clarify issues links in CONTRIBUTING.md

Open JCSzamosi opened this issue 2 years ago • 1 comments

This pull request is being submitted to all repos that have been converted to Workbench, so that they reflect a recent update in the Workbench template. The change is probably appropriate for your repository, but you may disagree. I encourage you to look at a description of the problem it fixes found in this comment of this issue.

You will still need to replace example.com/FIXME in the [repo] and [repo-issues] link targets with this repository.

It additionally fixes the broken [how-contribute] link.

JCSzamosi avatar Jun 12 '23 22:06 JCSzamosi

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:

  • :dart: correct output
  • :framed_picture: correct figures
  • :question: new warnings
  • :bangbang: new errors

Rendered Changes

:mag: Inspect the changes: https://github.com/datacarpentry/astronomy-python/compare/md-outputs..md-outputs-PR-205

The following changes were observed in the rendered markdown documents:


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-09-11 15:09:32 +0000

github-actions[bot] avatar Jun 12 '23 22:06 github-actions[bot]