Skip to content

Commit

Permalink
[Improvement]: Get started (phase 1): Move "Fork a repo" and "Contrib…
Browse files Browse the repository at this point in the history
…uting to projects" github#12501 (#47687)
  • Loading branch information
am-stead authored Dec 15, 2023
1 parent 052fb87 commit 1459ee6
Show file tree
Hide file tree
Showing 17 changed files with 31 additions and 28 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ You need to start by forking the demo repository.

1. Navigate to [https://github.com/dependabot/demo](https://github.com/dependabot/demo).
1. At the top of the page, on the right, click **{% octicon "repo-forked" aria-hidden="true" %} Fork**.
1. Select an owner (you can select your {% data variables.product.prodname_dotcom %} personal account) and type a repository name. For more information about forking repositories, see "[AUTOTITLE](/get-started/quickstart/fork-a-repo#forking-a-repository)."
1. Select an owner (you can select your {% data variables.product.prodname_dotcom %} personal account) and type a repository name. For more information about forking repositories, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo#forking-a-repository)."
1. Click **Create fork**.

## Enabling {% data variables.product.prodname_dependabot %} for your repository
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ For more information, see "[AUTOTITLE](/free-pro-team@latest/codespaces/overview
The following steps assume you have {% data variables.product.prodname_github_codespaces %} set up to edit files using {% data variables.product.prodname_vscode %} for Web. The steps are very similar if you have set a different editor. For more information, see "[AUTOTITLE](/free-pro-team@latest/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces)."

1. Navigate to the open source repository for {% data variables.product.prodname_docs %}, [`github/docs`](https://github.com/github/docs).
1. If you're an open source contributor, create a fork of the repository, then follow the rest of the steps in this procedure from your fork. For more information, see "[AUTOTITLE](/get-started/quickstart/fork-a-repo)."
1. If you're an open source contributor, create a fork of the repository, then follow the rest of the steps in this procedure from your fork. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)."
1. Create a branch to work on. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)."
1. On the main page of the repository, click **{% octicon "code" aria-hidden="true" %} Code**, then click **Create codespace on BRANCH-NAME**.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ You can also clone a repository directly from {% data variables.product.prodname

## Forking a repository

You can fork a repository on {% data variables.product.prodname_dotcom_the_website %} or in {% data variables.product.prodname_desktop %}. For information about forking on {% data variables.product.prodname_dotcom_the_website %}, see "[AUTOTITLE](/get-started/quickstart/fork-a-repo?tool=webui)."
You can fork a repository on {% data variables.product.prodname_dotcom_the_website %} or in {% data variables.product.prodname_desktop %}. For information about forking on {% data variables.product.prodname_dotcom_the_website %}, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo?tool=webui)."

{% data reusables.desktop.forking-a-repo %}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Contributing to projects
title: Contributing to a project
shortTitle: Contribute to a project
intro: Learn how to contribute to a project through forking.
permissions: '{% data reusables.enterprise-accounts.emu-permission-fork %}'
versions:
Expand All @@ -12,6 +13,8 @@ topics:
- Forks
- GitHub
- Open Source
redirect_from:
- /get-started/quickstart/contributing-to-projects
---

## About forking
Expand All @@ -20,7 +23,7 @@ If you want to contribute to someone else's project but don't have write access

{% data reusables.repositories.fork-definition-long %}

You can contribute by submitting pull requests from your fork to the upstream repository. For more information, see "[AUTOTITLE](/get-started/quickstart/fork-a-repo)."
You can contribute by submitting pull requests from your fork to the upstream repository. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)."

## Forking a repository

Expand Down Expand Up @@ -195,7 +198,7 @@ To do so, head on over to the repository on {% data variables.product.product_na

## Managing feedback

Pull Requests are an area for discussion. In this case, the Octocat is very busy, and probably won't merge your changes. For other projects, don't be offended if the project owner rejects your pull request, or asks for more information on why it's been made. It may even be that the project owner chooses not to merge your pull request, and that's totally okay. Your changes exist in your fork. And who knows--maybe someone you've never met will find your changes much more valuable than the original project.
Pull requests are an area for discussion. Don't be offended if the project owner rejects your pull request, or asks for more information on why it's been made. Even if the project owner chooses not to merge your pull request, your changes still exist in your fork. It could be that someone else will find your fork much more valuable than the original project.

## Finding projects

Expand Down
3 changes: 2 additions & 1 deletion content/get-started/exploring-projects-on-github/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,10 @@ topics:
- Projects
children:
- /finding-ways-to-contribute-to-open-source-on-github
- /contributing-to-a-project
- /saving-repositories-with-stars
- /following-people
- /following-organizations

shortTitle: Explore projects
---

3 changes: 1 addition & 2 deletions content/get-started/quickstart/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,7 @@ children:
- /creating-an-account-on-github
- /hello-world
- /set-up-git
- /fork-a-repo
- /github-flow
- /contributing-to-projects
- /be-social
- /communicating-on-github
- /github-glossary
Expand All @@ -26,3 +24,4 @@ children:
redirect_from:
- /github/getting-started-with-github/quickstart
---

2 changes: 1 addition & 1 deletion content/get-started/quickstart/set-up-git.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ If you want to work with Git locally, but do not want to use the command line, y
If you do not need to work with files locally, {% data variables.product.product_name %} lets you complete many Git-related actions directly in the browser, including:

- [AUTOTITLE](/repositories/creating-and-managing-repositories/quickstart-for-repositories)
- [Forking a repository](/get-started/quickstart/fork-a-repo)
- [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)
- [Managing files](/repositories/working-with-files/managing-files)
- [Being social](/get-started/quickstart/be-social)

Expand Down
2 changes: 1 addition & 1 deletion content/get-started/using-git/about-git.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,4 +163,4 @@ There are two primary ways people collaborate on {% data variables.product.produ

With a shared repository, individuals and teams are explicitly designated as contributors with read, write, or administrator access. This simple permission structure, combined with features like protected branches, helps teams progress quickly when they adopt {% data variables.product.product_name %}.

For an open source project, or for projects to which anyone can contribute, managing individual permissions can be challenging, but a fork and pull model allows anyone who can view the project to contribute. A fork is a copy of a project under a developer's personal account. Every developer has full control of their fork and is free to implement a fix or a new feature. Work completed in forks is either kept separate, or is surfaced back to the original project via a pull request. There, maintainers can review the suggested changes before they're merged. For more information, see "[AUTOTITLE](/get-started/quickstart/contributing-to-projects)."
For an open source project, or for projects to which anyone can contribute, managing individual permissions can be challenging, but a fork and pull model allows anyone who can view the project to contribute. A fork is a copy of a project under a developer's personal account. Every developer has full control of their fork and is free to implement a fix or a new feature. Work completed in forks is either kept separate, or is surfaced back to the original project via a pull request. There, maintainers can review the suggested changes before they're merged. For more information, see "[AUTOTITLE](/get-started/exploring-projects-on-github/contributing-to-a-project)."
6 changes: 3 additions & 3 deletions content/github-cli/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "{% data variables.product.prodname_cli %} documentation"
shortTitle: "{% data variables.product.prodname_cli %}"
title: '{% data variables.product.prodname_cli %} documentation'
shortTitle: '{% data variables.product.prodname_cli %}'
intro: '{% data reusables.cli.about-cli %}'
versions:
fpt: '*'
Expand All @@ -26,7 +26,7 @@ featuredLinks:
- /repositories/creating-and-managing-repositories/quickstart-for-repositories
- /pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally
- /pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request
- /get-started/quickstart/fork-a-repo
- /pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo
- /repositories/creating-and-managing-repositories/cloning-a-repository
popularHeading: Popular CLI tasks
changelog:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Deleting a fork will not delete the original upstream repository. You can make a

{% data reusables.repositories.you-can-fork %}

For instructions for forking a repository, see "[AUTOTITLE](/get-started/quickstart/fork-a-repo#forking-a-repository)." For more information about when you can create forks, and the permission and visibility settings of forks, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)."
For instructions for forking a repository, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)." For more information about when you can create forks, and the permission and visibility settings of forks, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)."

{% tip %}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
---
title: Fork a repo
title: Fork a repository
allowTitleToDifferFromFilename: true
redirect_from:
- /fork-a-repo
- /forking
- /articles/fork-a-repo
- /github/getting-started-with-github/fork-a-repo
- /github/getting-started-with-github/quickstart/fork-a-repo
- /get-started/quickstart/fork-a-repo
intro: A fork is a new repository that shares code and visibility settings with the original “upstream” repository.
permissions: '{% data reusables.enterprise-accounts.emu-permission-fork %}'
versions:
Expand Down Expand Up @@ -96,7 +98,7 @@ gh repo fork REPOSITORY --org "octo-org"

{% desktop %}

You can fork a repository on {% data variables.product.prodname_dotcom_the_website %} or in {% data variables.product.prodname_desktop %}. For information about forking on {% data variables.product.prodname_dotcom_the_website %}, see [the web browser version of this article](/get-started/quickstart/fork-a-repo?tool=webui).
You can fork a repository on {% data variables.product.prodname_dotcom_the_website %} or in {% data variables.product.prodname_desktop %}. For information about forking on {% data variables.product.prodname_dotcom_the_website %}, see [the web browser version of this article](/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo?tool=webui).

{% data reusables.desktop.forking-a-repo %}

Expand Down Expand Up @@ -228,12 +230,10 @@ Fork a repository to start contributing to a project. {% data reusables.reposito

{% endif %}

## Next Steps
## Next steps

You have now forked a repository, practiced cloning your fork, and configured an upstream repository.

- For more information about cloning the fork and syncing the changes in a forked repository from your computer, see "[AUTOTITLE](/get-started/quickstart/set-up-git)."

- You can also create a new repository where you can put all your projects and share the code on {% data variables.product.prodname_dotcom %}. {% data reusables.getting-started.create-a-repository %}"

- {% data reusables.getting-started.being-social %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ topics:
- Pull requests
children:
- /about-forks
- /fork-a-repo
- /about-permissions-and-visibility-of-forks
- /configuring-a-remote-repository-for-a-fork
- /syncing-a-fork
- /allowing-changes-to-a-pull-request-branch-created-from-a-fork
- /what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility
---

Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ shortTitle: Edit files

## Editing files in another user's repository

When you edit a file in another user's repository, we'll automatically [fork the repository](/get-started/quickstart/fork-a-repo) and [open a pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for you.
When you edit a file in another user's repository, we'll automatically [fork the repository](/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) and [open a pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for you.

1. In another user's repository, browse to the folder that contains the file you want to edit. Click the name of the file you want to edit.
1. Above the file content, click {% octicon "pencil" aria-label="Edit file" %}. At this point, {% data variables.product.prodname_dotcom %} forks the repository for you.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ topics:
- Legal
---

GitHub provides [a number of account recovery methods](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials) including an [automated recovery process](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials#authenticating-with-a-verified-device-ssh-token-or-personal-access-token) if you have lost access to your GitHub.com account. **If you cannot use any of the provided recovery methods, you have permanently lost access to your account.**
GitHub provides [a number of account recovery methods](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials) including an [automated recovery process](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials#authenticating-with-a-verified-device-ssh-token-or-personal-access-token) if you have lost access to your GitHub.com account. **If you cannot use any of the provided recovery methods, you have permanently lost access to your account.**

You can, however, [unlink email addresses](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/unlinking-your-email-address-from-a-locked-account) from a locked account in order to create a new account or use the email on another existing account.

Expand All @@ -28,7 +28,7 @@ Please contact Support to request removal of a payment method from a locked out

## Can I recover the contents of a user or organization account I lost access to?

If you have lost access to a user account, you may [clone](/repositories/creating-and-managing-repositories/cloning-a-repository) or [fork](/get-started/quickstart/fork-a-repo) any content that is public.
If you have lost access to a user account, you may [clone](/repositories/creating-and-managing-repositories/cloning-a-repository) or [fork](/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) any content that is public.

If you have lost access to an organization account, you may clone or fork any content that is public and you may be able to request that remaining members of the organization clone or fork any private content.

Expand Down
2 changes: 1 addition & 1 deletion data/reusables/getting-started/contributing-to-projects.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{% data variables.product.prodname_dotcom %} connects users and allows you to interact with other projects. To learn more about contributing to someone else's project, see "[AUTOTITLE](/get-started/quickstart/contributing-to-projects)."
{% data variables.product.prodname_dotcom %} connects users and allows you to interact with other projects. To learn more about contributing to someone else's project, see "[AUTOTITLE](/get-started/exploring-projects-on-github/contributing-to-a-project)."
2 changes: 1 addition & 1 deletion data/reusables/getting-started/fork-a-repository.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Forking a repository will allow you to make changes to another repository without affecting the original. For more information, see "[AUTOTITLE](/get-started/quickstart/fork-a-repo)."
Forking a repository will allow you to make changes to another repository without affecting the original. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)."
4 changes: 2 additions & 2 deletions src/redirects/tests/redirects.js
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ describe('redirects', () => {
})

describe('enterprise user article', () => {
const userArticle = `/en/enterprise-server@${enterpriseServerReleases.latest}/get-started/quickstart/fork-a-repo`
const userArticle = `/en/enterprise-server@${enterpriseServerReleases.latest}/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo`

test('no product redirects to GitHub.com product on the latest version', async () => {
const res = await get(
Expand Down Expand Up @@ -343,7 +343,7 @@ describe('redirects', () => {
})

describe('enterprise user article with frontmatter redirect', () => {
const userArticle = `/en/enterprise-server@${enterpriseServerReleases.latest}/get-started/quickstart/fork-a-repo`
const userArticle = `/en/enterprise-server@${enterpriseServerReleases.latest}/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo`
const redirectFromPath = '/articles/fork-a-repo'

test('redirects to expected article', async () => {
Expand Down

0 comments on commit 1459ee6

Please sign in to comment.