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 #209

Merged
merged 3 commits into from
Jun 13, 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.

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.

@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-data-intro/compare/md-outputs..md-outputs-PR-209

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 22:42:04 +0000

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Contributor

@sharilaster sharilaster left a comment

Choose a reason for hiding this comment

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

Thank you @JCSzamosi! I believe I have correctly suggested in the updated websites... @kevintfrench can you see if it looks ok to you? Once you have approved we can merge.

JCSzamosi and others added 2 commits June 13, 2023 11:49
Co-authored-by: Shari Laster <[email protected]>
Co-authored-by: Shari Laster <[email protected]>
@JCSzamosi
Copy link
Contributor Author

Looks great! I have committed your suggestions to the PR

Copy link
Member

@kevintfrench kevintfrench left a comment

Choose a reason for hiding this comment

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

This is readable and all the links work. I was momentarily confused when, reading the changes in the context of the document, I used the navigation link in number 3 and I remained on the same page since my screen held the entire document. I wonder if it would be better to leave that link out and retain the directions to look below but, this is my first time commenting and I may be over analyzing.

github-actions bot pushed a commit that referenced this pull request Jun 13, 2023
@sharilaster
Copy link
Contributor

@kevintfrench thanks for looking! In this case, this is standard content and formatting, with the pull request from the folks at the Carpentries who have just updated the lessons across the board. The part that was a little tricky on our side was making sure we got the correct URLs updated that are specific to the lesson, and @JCSzamosi double-checked that too. So it sounds like we're all good on the content and I will go ahead and merge.

@sharilaster sharilaster merged commit 06fa19e into LibraryCarpentry:main Jun 13, 2023
@kevintfrench
Copy link
Member

Sounds good @sharilaster I appreciate the explanation.

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