Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify issues links in CONTRIBUTING.md #288

Merged
merged 1 commit into from
Jun 20, 2023

Conversation

JCSzamosi
Copy link
Contributor

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.

@github-actions
Copy link

github-actions bot commented Jun 12, 2023

Thank you!

Thank you for your pull request 😃

🤖 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:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/LibraryCarpentry/lc-open-refine/compare/md-outputs..md-outputs-PR-288

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.

⏱️ Updated at 2023-06-13 09:03:59 +0000

Copy link
Contributor

@jas58 jas58 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think @ostephens made this update locally with 285 and #286. The order seems reversed, but perhaps not important.
I'm not sure about the link or text "included below"--Would a youtube link like Midwest Big Data Hub's be less intimidating? https://www.youtube.com/watch?v=BpEWDg8AbPc

@ostephens
Copy link
Contributor

ostephens commented Jun 13, 2023

@jas58 @JCSzamosi the changes I made were in line with the original issue but these changes go a bit further to:

  • link directly to the repository issues where the instruction is to create/view issues
  • Add a link to all open issues across the carpentries

I complete agree that the "included below" text and link not great - but they haven't changed in this PR so need a separate issue if we are going to change them. This text and link seems to be standard across the carpentries so might need some wider discussion. @tobyhodges might be able to comment on this

@ostephens ostephens self-requested a review June 13, 2023 09:02
github-actions bot pushed a commit that referenced this pull request Jun 13, 2023
@ostephens ostephens merged commit e1b462b into LibraryCarpentry:main Jun 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants