Skip to content

Conversation

@TejBhat
Copy link

@TejBhat TejBhat commented Dec 24, 2025

Why:

Improves clarity and readability in the Git setup instructions to help new users better understand their options for working with Git.

No existing issue - this is a minor documentation improvement.

What's being changed:

File changed: content/get-started/git-basics/set-up-git.md

Specific improvements:

  • Line 30: Simplified the sentence structure by removing redundant word "will"

    • Before: "you will need to download"
    • After: "you need to download"
  • Line 34: Improved clarity by changing "need" to "want" for the local file editing scenario

    • Before: "If you do not need to work with files locally"
    • After: "If you do not want to work with files locally"
    • This better reflects user choice rather than necessity

Reasoning:

  • Removes unnecessary future tense for more direct instructions
  • "Want" is more accurate than "need" in this context, as working with files locally is a preference, not a requirement
  • Makes the documentation flow more naturally for readers

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the review environment.

Note: This is my first contribution to open source. I've made my best effort to follow the contribution guidelines. I welcome any feedback for improvement!

Copilot AI review requested due to automatic review settings December 24, 2025 15:25
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Dec 24, 2025
@github-actions
Copy link
Contributor

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
get-started/git-basics/set-up-git.md fpt
ghec
ghes@ 3.19 3.18 3.17 3.16 3.15 3.14
fpt
ghec
ghes@ 3.19 3.18 3.17 3.16 3.15 3.14

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

Copy link
Contributor

Copilot AI left a comment

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 improves the readability and clarity of the Git setup instructions by making the language more direct and user-friendly.

Key changes:

  • Simplified instruction language by removing unnecessary future tense ("will need" → "need")
  • Changed "need" to "want" to better reflect user choice in working with files locally

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

## Using Git

To use Git on the command line, you will need to download, install, and configure Git on your computer. You can also install {% data variables.product.prodname_cli %} to use {% data variables.product.prodname_dotcom %} from the command line. For more information, see [AUTOTITLE](/github-cli/github-cli/about-github-cli).
To use Git on the command line, you need to download, install, and configure Git on your computer. You can also install {% data variables.product.prodname_cli %} to use {% data variables.product.prodname_dotcom %} from the command line. For more information, see [AUTOTITLE](/github-cli/github-cli/about-github-cli).
Copy link

Copilot AI Dec 24, 2025

Choose a reason for hiding this comment

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

This change improves directness by removing "will", but creates an inconsistency with line 57 which still uses "you will need to authenticate". Consider updating line 57 to "you need to authenticate" for consistency throughout the document.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

triage Do not begin working on this issue until triaged by the team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant