Skip to content

fix: improve clarity and grammar in lesson steps - #34

Open
NabilMx99 wants to merge 2 commits into
skills:mainfrom
NabilMx99:docs/grammar-fix
Open

fix: improve clarity and grammar in lesson steps#34
NabilMx99 wants to merge 2 commits into
skills:mainfrom
NabilMx99:docs/grammar-fix

Conversation

@NabilMx99

@NabilMx99 NabilMx99 commented Jun 30, 2026

Copy link
Copy Markdown

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:

  • Reworded and clarified explanations throughout .github/steps/1-step.md, .github/steps/2-step.md, .github/steps/3-step.md, and .github/steps/4-step.md to 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:

  • Updated section headings and descriptions to use more standard terminology (e.g., "Essential Git Commands" and "Git Diff Commands") and clarified the purpose and effect of commands like git add, git commit, and git status. [1] [2] [3]

Step-by-step instruction enhancements:

  • Improved step instructions for using the terminal and VS Code, making actions and expected results clearer (e.g., how to open the terminal, how to add files to staging, and how to commit changes). [1] [2] [3] [4] [5]

Consistency and tone adjustments:

  • Standardized phrasing and tone for a more consistent and approachable tutorial experience (e.g., using "Add" instead of "Promote," and making instructions more direct). [1] [2] [3] [4]

Additional context and tips:

  • Enhanced tips and warning callouts for better user guidance, including privacy considerations and troubleshooting steps. [1] [2] [3] [4]

Closes:

Task list

  • For workflow changes, I have verified the Actions workflows function as expected.
  • For content changes, I have reviewed the style guide.

Copilot AI review requested due to automatic review settings June 30, 2026 14:49

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.

Comment thread .github/steps/1-step.md Outdated
Comment thread .github/steps/1-step.md
Comment thread .github/steps/2-step.md
Comment thread .github/steps/5-step.md
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@velmurugan61682-ai

Copy link
Copy Markdown

Looks good. The changes improve the README clarity and user onboarding experience.

@SenukaEdi

Copy link
Copy Markdown

Approved, the changes made to the readme file are correct.

@allwinaannasoyjose-eng

Copy link
Copy Markdown

Approved

@allwinaannasoyjose-eng allwinaannasoyjose-eng left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

No comments

Comment thread .github/steps/1-step.md
@allwinaannasoyjose-eng

Copy link
Copy Markdown

ok

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

5 participants