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

Stress the importance of git status (#685) #980

Merged
merged 3 commits into from
Jul 3, 2024

Conversation

jdvorak001
Copy link
Contributor

Closes #685

Based on the discussion in the issue, I'm limiting the changes to just giving a bit of emphasis on the moment the git status command is first used.

Copy link

🆗 Pre-flight checks passed 😃

This pull request has been checked and contains no modified workflow files, spoofing, or invalid commits.

It should be safe to Approve and Run the workflows that need maintainer approval.

Copy link
Contributor

@kekoziar kekoziar left a comment

Choose a reason for hiding this comment

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

I'm not sure it's the same as ls. Maybe, instead of It's the Git equivalent of listing a directory in a shell. it can be "It tells us the status of our project, and better, a list of changes in the project and options on how to resolve those changes"

@jdvorak001
Copy link
Contributor Author

Ok, I see it's a bit imprecise to say the Git equivalent of ...

@kekoziar kekoziar requested a review from martinosorb November 21, 2023 21:05
Copy link
Contributor

@kekoziar kekoziar left a comment

Choose a reason for hiding this comment

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

I like it. Thanks for the quick change. I tagged another maintainer for review.

@martinosorb
Copy link
Contributor

I like the idea of adding more emphasis on this command at that point. However, I think the phrasing is a bit off:

  • And now we will use what I think is the most important...: I think nowhere in Carpentries materials the lessons use "I" -- who is "I" here?
  • git status reports on the status of our project. It tells us the status of our project... there is a clear repetition here

I would suggest something like We can now start using one of the most important git commands, which is particularly helpful to beginners. git status tells us the status of our project, and better, a list of changes in the project and options on what to do with those changes. We can use it as often as we want, whenever we want to understand what is going on.

@martinosorb martinosorb added the status:changes requested Waiting for Contributor to update PR label Mar 25, 2024
Copy link
Contributor

@martinosorb martinosorb left a comment

Choose a reason for hiding this comment

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

See above.

@jdvorak001
Copy link
Contributor Author

jdvorak001 commented Jul 3, 2024

@martinosorb, your formulation is very good. I committed it with you as author.

@martinosorb
Copy link
Contributor

Thank you so much!

@martinosorb martinosorb merged commit 6b470fd into swcarpentry:main Jul 3, 2024
1 check passed
github-actions bot pushed a commit that referenced this pull request Jul 3, 2024
Auto-generated via {sandpaper}
Source  : 6b470fd
Branch  : main
Author  : Martino Sorbaro <martinosorb@users.noreply.github.com>
Time    : 2024-07-03 13:10:49 +0000
Message : Merge pull request #980 from jdvorak001/patch-1

Stress the importance of `git status` (#685)
github-actions bot pushed a commit that referenced this pull request Jul 3, 2024
Auto-generated via {sandpaper}
Source  : eefd47c
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2024-07-03 13:11:46 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 6b470fd
Branch  : main
Author  : Martino Sorbaro <martinosorb@users.noreply.github.com>
Time    : 2024-07-03 13:10:49 +0000
Message : Merge pull request #980 from jdvorak001/patch-1

Stress the importance of `git status` (#685)
@jdvorak001 jdvorak001 deleted the patch-1 branch July 3, 2024 13:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status:changes requested Waiting for Contributor to update PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Episode 3 suggests to use git status before initializing a repo, but does not show that
3 participants