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

Remove reference to gitignore #1036

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

erinmgraham
Copy link
Contributor

I agree with issue #687 contributors that the reference to .gitignore in this callout comes out of nowhere so I'm removing it for now.

However, this callout needs to be revisited to consider having it in this location in the lesson and the fact that it makes changes that might be missed. (Instructors pressed for time will selectively skip callouts and this may have downstream effects.)

Note that there are some unintended changes due to line endings or whitespace adjustments which I will aim to fix in the PR :-(

Copy link

github-actions bot commented Nov 3, 2024

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/swcarpentry/git-novice/compare/md-outputs..md-outputs-PR-1036

The following changes were observed in the rendered markdown documents:

 04-changes.md | 1639 ++++++++++++++++++++++++++++-----------------------------
 md5sum.txt    |    2 +-
 2 files changed, 819 insertions(+), 822 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.

⏱️ Updated at 2024-11-18 00:19:43 +0000

github-actions bot pushed a commit that referenced this pull request Nov 3, 2024
@martinosorb
Copy link
Contributor

Looks good to me, but I'm confused on why Git is marking every line of the file as a change. Is there a way to fix it? If it's about line endings, I'm worried this might mess up the markdown parser (although it's unlikely).

@erinmgraham
Copy link
Contributor Author

erinmgraham commented Nov 4, 2024 via email

@martinosorb
Copy link
Contributor

I noticed it's possible to get github to show the actual changes by clicking on the gear and selecting 'hide whitespace'.

Should we keep the part that says 'these files are not special and their sole purpose is to populate a directory so that Git adds it to the repository' perhaps?

github-actions bot pushed a commit that referenced this pull request Nov 18, 2024
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.

2 participants