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

Updated GitHub desktop fork instructions #36172

Open
wants to merge 24 commits into
base: main
Choose a base branch
from

Conversation

warp-core
Copy link

@warp-core warp-core commented Feb 4, 2025

Most of this description, and most of the changes here, are from #34151, I just made the changes requested in the last review that PR received before being closed.

Why: The current fork instructions for Github desktop were out of date with the latest Github desktop.

Closes: desktop/desktop#13165 (I realize this is an issue from a different repository, however in the comment thread of that issue you will see people mentioning that the issue arises because the docs here need updating.)

What's being changed (if available, include any code snippets, screenshots, or gifs): Minor documentation changes, inluding updating screenshots. The easiest way to see the changes would be to look at the PRs file changes.

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 preview environment.

Copy link

welcome bot commented Feb 4, 2025

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Feb 4, 2025
Copy link
Contributor

github-actions bot commented Feb 4, 2025

👓 Previews for changed content

This comment is 🤖 automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the review server. Please note that changes to the data directory will not show up in this table.

‼️ You can also preview changes using Codespaces or by spinning up a local environment. If you have trouble with the review server, use one of those options to preview your changes.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
desktop/adding-and-cloning-repositories/cloning-and-forking-repositories-from-github-desktop.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server
This table is posted from the Content Changes Table Comment workflow.

Features the Windows screenshot instead of the Mac one to match the others appearing in the "fork-a-repo" reusable.
@warp-core
Copy link
Author

Which naming style is preferred: "url" or "url-tab"?

@isaacmbrown isaacmbrown added waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Feb 5, 2025
@isaacmbrown
Copy link
Contributor

@warp-core 👋 Thanks for the PR and linking to the desktop issue for context! I've added this to our review board.

@steveward If you have time, I'm wondering if you're up for reviewing this since you have the context from the issue. No worries if not, I'll leave it on a board so anyone can pick it up.

@steveward
Copy link
Member

@isaacmbrown Will do!

@warp-core I'll take a look at this and will get back to you soon. Thanks for the PR!

Copy link
Member

@steveward steveward left a comment

Choose a reason for hiding this comment

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

Thanks again for putting this PR together @warp-core. I suggested a few minor changes. Once those are made I'll take a final look and we can get this merged.

@@ -18,7 +18,7 @@ You can create a local copy of any repository on {% data variables.product.githu

When you clone a repository, any changes you push to {% data variables.product.github %} will affect the original repository. To make changes without affecting the original project, you can create a separate copy by forking the repository. You can create a pull request to propose that maintainers incorporate the changes in your fork into the original upstream repository. For more information, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks).

When you try to use {% data variables.product.prodname_desktop %} to clone a repository that you do not have write access to, {% data variables.product.prodname_desktop %} will prompt you to create a fork automatically. You can choose to use your fork to contribute to the original upstream repository or to work independently on your own project. Any existing forks default to contributing changes to their upstream repositories. You can modify this choice at any time. For more information, see [Managing fork behavior](#managing-fork-behavior).
When you use {% data variables.product.prodname_desktop %} to push new commits to a repository that you do not have write access to, {% data variables.product.prodname_desktop %} will prompt you to create a fork. You can choose to use your fork to contribute to the original upstream repository or to work independently on your own project. Any existing forks default to contributing changes to their upstream repositories. You can modify this choice at any time. For more information, see [Managing fork behavior](#managing-fork-behavior).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
When you use {% data variables.product.prodname_desktop %} to push new commits to a repository that you do not have write access to, {% data variables.product.prodname_desktop %} will prompt you to create a fork. You can choose to use your fork to contribute to the original upstream repository or to work independently on your own project. Any existing forks default to contributing changes to their upstream repositories. You can modify this choice at any time. For more information, see [Managing fork behavior](#managing-fork-behavior).
When you use {% data variables.product.prodname_desktop %} to push a change to a repository that you do not have write access to, {% data variables.product.prodname_desktop %} will prompt you to create a fork. You can choose to use your fork to contribute to the original upstream repository or to work independently on your own project. Any existing forks default to contributing changes to their upstream repositories. You can modify this choice at any time. For more information, see [Managing fork behavior](#managing-fork-behavior).

@@ -1,8 +1,9 @@
In {% data variables.product.prodname_desktop %}, if you attempt to clone a repository that you don't have write access to, a fork is automatically created for you.
In {% data variables.product.prodname_desktop %}, if you clone a repository that you don't have write access to, and then attempt to push new commits to the repository, a fork will be created for you.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
In {% data variables.product.prodname_desktop %}, if you clone a repository that you don't have write access to, and then attempt to push new commits to the repository, a fork will be created for you.
In {% data variables.product.prodname_desktop %}, if you clone a repository that you don not have write access to, and then attempt to push a change to the repository, a fork will be created for you.

@@ -0,0 +1,3 @@
1. To create a fork, attempt to write a change to the repository. For example, create a new branch and publish it. A prompt will appear asking if you want to fork this repository. Click "Fork this repository"
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
1. To create a fork, attempt to write a change to the repository. For example, create a new branch and publish it. A prompt will appear asking if you want to fork this repository. Click "Fork this repository"
1. To create a fork, attempt to push a change to the repository. For example, create a new branch and publish it. A prompt will appear asking if you want to fork this repository.

@@ -0,0 +1,3 @@
1. Click the tab that corresponds to the location of the repository you want to clone. In this example, we click on the URL tab.

![Screenshot of the "Clone a repository" window. At the top of the window, "GitHub.com", "GitHub Enterprise" and "URL" tabs are outlined in orange. The "URL" tab is selected.](/assets/images/help/desktop/choose-repository-location-url-tab-windows.png)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
![Screenshot of the "Clone a repository" window. At the top of the window, "GitHub.com", "GitHub Enterprise" and "URL" tabs are outlined in orange. The "URL" tab is selected.](/assets/images/help/desktop/choose-repository-location-url-tab-windows.png)
![Screenshot of the "URL" tab of the "Clone a repository" window. At the top of the window, "GitHub.com", "GitHub Enterprise" and "URL" tabs are outlined in orange.](/assets/images/help/desktop/choose-repository-location-url-tab-windows.png)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

GitHub desktop cannot automatically prompt me to create a fork
4 participants