fix: improve clarity and grammar in lesson steps - #34
Open
NabilMx99 wants to merge 2 commits into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR refines the written instructions in the Git tutorial steps to improve clarity, consistency, and learner guidance across multiple lessons in .github/steps/.
Changes:
- Reworded multiple lesson sections for clearer explanations and more direct, actionable instructions.
- Updated headings/terminology for command groupings (e.g., “Git Diff Commands”, “Git Branch Commands”, “Essential Git Commands”).
- Streamlined collaboration workflow wording and branching guidance.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| .github/steps/1-step.md | Improves wording in CLI/setup steps; introduces a terminology issue around user.name being called a “username”. |
| .github/steps/2-step.md | Clarifies Git workflow/commands; introduces a punctuation + apostrophe consistency typo in a TIP callout. |
| .github/steps/3-step.md | Tightens phrasing around history concepts and common git log usage. |
| .github/steps/4-step.md | Improves diff terminology and step instructions for CLI/VS Code diff workflows. |
| .github/steps/5-step.md | Clarifies branching concepts/commands and activity instructions; PR description doesn’t mention this file (or step 6). |
| .github/steps/6-step.md | Refines collaboration intro and simplifies the collaboration workflow list. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
Looks good. The changes improve the README clarity and user onboarding experience. |
|
Approved, the changes made to the readme file are correct. |
|
Approved |
|
ok |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Improved the clarity and instructional quality of the Git tutorial steps. The changes refine explanations, update terminology, and enhance the step-by-step instructions for a better learning experience.
Changes
Documentation clarity and instructional improvements:
.github/steps/1-step.md,.github/steps/2-step.md,.github/steps/3-step.md, and.github/steps/4-step.mdto improve readability and instructional flow, such as simplifying sentences, updating terminology (e.g., "author name" instead of "display name"), and making step instructions more concise and actionable. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19] [20] [21]Terminology and command usage updates:
git add,git commit, andgit status. [1] [2] [3]Step-by-step instruction enhancements:
Consistency and tone adjustments:
Additional context and tips:
Closes:
Task list