Skip to content

Fix missing 'git' prefix in GitGuide.md example#9664

Merged
maliberty merged 1 commit intoThe-OpenROAD-Project:masterfrom
Pinata-Consulting:fix-gitguide-command
Mar 6, 2026
Merged

Fix missing 'git' prefix in GitGuide.md example#9664
maliberty merged 1 commit intoThe-OpenROAD-Project:masterfrom
Pinata-Consulting:fix-gitguide-command

Conversation

@oharboe
Copy link
Collaborator

@oharboe oharboe commented Mar 6, 2026

No description provided.

Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request correctly fixes a typo in a git command example in GitGuide.md. I've also added a suggestion to simplify the example code block to make it more concise and easier for beginners to understand.

Note: Security Review has been skipped due to the limited scope of the PR.

Comment on lines 31 to +34
git checkout master && git branch shiny-new-feature
git checkout shiny-new-feature
# Or equivalently,
git checkout master && checkout -b shiny-new-feature
git checkout master && git checkout -b shiny-new-feature
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

While your fix for the typo is correct, the entire example block could be simplified to be more direct and idiomatic for a git quickstart guide. The current examples are a bit verbose and show a non-standard way of creating a branch. A single command can achieve the desired outcome of creating a new branch from master and switching to it, which is clearer for new contributors.

Suggested change
git checkout master && git branch shiny-new-feature
git checkout shiny-new-feature
# Or equivalently,
git checkout master && checkout -b shiny-new-feature
git checkout master && git checkout -b shiny-new-feature
# Create a new branch 'shiny-new-feature' from 'master' and switch to it
git checkout -b shiny-new-feature master

@github-actions
Copy link
Contributor

github-actions bot commented Mar 6, 2026

clang-tidy review says "All clean, LGTM! 👍"

@maliberty maliberty enabled auto-merge March 6, 2026 06:59
@maliberty maliberty merged commit c7d36e1 into The-OpenROAD-Project:master Mar 6, 2026
13 of 14 checks passed
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