ran script/content-migrations/remove-map-topics.js && script/content-migrations/update-tocs.js
This commit is contained in:
Sarah Schneider
@@ -0,0 +1,79 @@
|
||||
---
|
||||
title: Be social
|
||||
redirect_from:
|
||||
- /be-social/
|
||||
- /articles/be-social
|
||||
- /github/getting-started-with-github/be-social
|
||||
intro: 'You can interact with people, repositories, and organizations on {% data variables.product.prodname_dotcom %}. See what others are working on and who they''re connecting with from your personal dashboard.'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- Profile
|
||||
- Pull requests
|
||||
- Issues
|
||||
- Notifications
|
||||
- Accounts
|
||||
---
|
||||
To learn about accessing your personal dashboard, see "[About your personal dashboard](/articles/about-your-personal-dashboard)."
|
||||
|
||||
### Following people
|
||||
|
||||
When you follow someone on {% data variables.product.product_location %}, you'll get notifications on your personal dashboard about their activity. For more information, see "[About your personal dashboard](/articles/about-your-personal-dashboard)."
|
||||
|
||||
Click **Follow** on a person's profile page to follow them.
|
||||
|
||||
|
||||
|
||||
### Watching a repository
|
||||
|
||||
You can watch a repository to receive notifications for new pull requests and issues. When the owner updates the repository, you'll see the changes in your personal dashboard. For more information see {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}"[Viewing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions){% else %}"[Watching and unwatching repositories](/github/receiving-notifications-about-activity-on-github/watching-and-unwatching-repositories){% endif %}."
|
||||
|
||||
Click **Watch** at the top of a repository to watch it.
|
||||
|
||||
|
||||
|
||||
### Joining the conversation
|
||||
|
||||
{% data reusables.support.ask-and-answer-forum %}
|
||||
|
||||
### Communicating on {% data variables.product.product_name %}
|
||||
|
||||
{% data variables.product.product_name %} provides built-in collaborative communication tools, such as issues and pull requests, allowing you to interact closely with your community when building great software. For an overview of these tools, and information about the specificity of each, see "[Quickstart for communicating on {% data variables.product.prodname_dotcom %}](/github/collaborating-with-issues-and-pull-requests/quickstart-for-communicating-on-github)."
|
||||
|
||||
### Doing even more
|
||||
|
||||
#### Creating pull requests
|
||||
|
||||
You may want to contribute to another person's project, whether to add features or to fix bugs. After making changes, let the original author know by sending a pull request. For more information, see "[About pull requests](/articles/about-pull-requests)."
|
||||
|
||||
|
||||
|
||||
#### Using issues
|
||||
|
||||
When collaborating on a repository, use issues to track ideas, enhancements, tasks, or bugs. For more information, see '[About issues](/articles/about-issues/)."
|
||||
|
||||
|
||||
|
||||
#### Participating in organizations
|
||||
|
||||
Organizations are shared accounts where businesses and open-source projects can collaborate across many projects at once. Owners and administrators can establish teams with special permissions, have a public organization profile, and keep track of activity within the organization. For more information, see "[About organizations](/articles/about-organizations/)."
|
||||
|
||||
|
||||
|
||||
#### Exploring other projects on {% data variables.product.prodname_dotcom %}
|
||||
|
||||
Discover interesting projects using {% data variables.explore.explore_github %}, [Explore repositories](https://github.com/explore), and the {% data variables.explore.trending_page %}. Star interesting projects and come back to them later. Visit your {% data variables.explore.your_stars_page %} to see all your starred projects. For more information, see "[About your personal dashboard](/articles/about-your-personal-dashboard/)."
|
||||
|
||||
### Celebrate
|
||||
|
||||
You're now connected to the {% data variables.product.product_name %} community. What do you want to do next?
|
||||
|
||||
|
||||
|
||||
- "[Set up Git](/articles/set-up-git)"
|
||||
- "[Create a repository](/articles/create-a-repo)"
|
||||
- "[Fork a repository](/articles/fork-a-repo)"
|
||||
- **Be social**
|
||||
- {% data reusables.support.connect-in-the-forum-bootcamp %}
|
||||
@@ -0,0 +1,87 @@
|
||||
---
|
||||
title: Create a repo
|
||||
redirect_from:
|
||||
- /create-a-repo/
|
||||
- /articles/create-a-repo
|
||||
- /github/getting-started-with-github/create-a-repo
|
||||
intro: 'To put your project up on {% data variables.product.product_location %}, you''ll need to create a repository for it to live in.'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- Pull requests
|
||||
- Issues
|
||||
- Notifications
|
||||
- Accounts
|
||||
---
|
||||
### Create a repository
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
|
||||
You can store a variety of projects in {% data variables.product.product_name %} repositories, including open source projects. With [open source projects](http://opensource.org/about), you can share code to make better, more reliable software.
|
||||
|
||||
{% elsif enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
|
||||
|
||||
You can store a variety of projects in {% data variables.product.product_name %} repositories, including innersource projects. With innersource, you can share code to make better, more reliable software. For more information on innersource, see {% data variables.product.company_short %}'s white paper "[An introduction to innersource](https://resources.github.com/whitepapers/introduction-to-innersource/)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** You can create public repositories for an open source project. When creating your public repository, make sure to include a [license file](https://choosealicense.com/) that determines how you want your project to be shared with others. {% data reusables.open-source.open-source-guide-repositories %} {% data reusables.open-source.open-source-learning-lab %}
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% data reusables.repositories.create_new %}
|
||||
2. Type a short, memorable name for your repository. For example, "hello-world".
|
||||
|
||||
3. Optionally, add a description of your repository. For example, "My first repository on {% data variables.product.product_name %}."
|
||||
|
||||
{% data reusables.repositories.choose-repo-visibility %}
|
||||
{% data reusables.repositories.initialize-with-readme %}
|
||||
{% data reusables.repositories.create-repo %}
|
||||
|
||||
Congratulations! You've successfully created your first repository, and initialized it with a *README* file.
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
|
||||
{% tip %}
|
||||
|
||||
**Tip**: You can also create repositories using the {% data variables.product.prodname_cli %}. For more information, see "[`gh repo create`](https://cli.github.com/manual/gh_repo_create)" in the {% data variables.product.prodname_cli %} documentation.
|
||||
|
||||
{% endtip %}
|
||||
{% endif %}
|
||||
|
||||
### Commit your first change
|
||||
|
||||
A *[commit](/articles/github-glossary#commit)* is like a snapshot of all the files in your project at a particular point in time.
|
||||
|
||||
When you created your new repository, you initialized it with a *README* file. *README* files are a great place to describe your project in more detail, or add some documentation such as how to install or use your project. The contents of your *README* file are automatically shown on the front page of your repository.
|
||||
|
||||
Let's commit a change to the *README* file.
|
||||
|
||||
1. In your repository's list of files, click ***README.md***.
|
||||
|
||||
2. Above the file's content, click {% octicon "pencil" aria-label="The edit icon" %}.
|
||||
3. On the **Edit file** tab, type some information about yourself.
|
||||
|
||||
{% data reusables.files.preview_change %}
|
||||
5. Review the changes you made to the file. You'll see the new content in green.
|
||||
|
||||
{% data reusables.files.write_commit_message %}
|
||||
{% data reusables.files.choose_commit_branch %}
|
||||
{% data reusables.files.propose_file_change %}
|
||||
|
||||
### Celebrate
|
||||
|
||||
Congratulations! You have now created a repository, including a *README* file, and created your first commit on {% data variables.product.product_location %}. What do you want to do next?
|
||||
|
||||
- "[Set up Git](/articles/set-up-git)"
|
||||
- **Create a repository**
|
||||
- "[Fork a repository](/articles/fork-a-repo)"
|
||||
- "[Be social](/articles/be-social)"
|
||||
- {% data reusables.support.connect-in-the-forum-bootcamp %}
|
||||
@@ -0,0 +1,158 @@
|
||||
---
|
||||
title: Fork a repo
|
||||
redirect_from:
|
||||
- /fork-a-repo/
|
||||
- /forking/
|
||||
- /articles/fork-a-repo
|
||||
- /github/getting-started-with-github/fork-a-repo
|
||||
intro: A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project.
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- Pull requests
|
||||
- Issues
|
||||
- Notifications
|
||||
- Accounts
|
||||
---
|
||||
### About forks
|
||||
|
||||
Most commonly, forks are used to either propose changes to someone else's project or to use someone else's project as a starting point for your own idea.
|
||||
|
||||
#### Propose changes to someone else's project
|
||||
|
||||
For example, you can use forks to propose changes related to fixing a bug. Rather than logging an issue for a bug you've found, you can:
|
||||
|
||||
- Fork the repository.
|
||||
- Make the fix.
|
||||
- Submit a pull request to the project owner.
|
||||
|
||||
#### Use someone else's project as a starting point for your own idea.
|
||||
|
||||
Open source software is based on the idea that by sharing code, we can make better, more reliable software. For more information, see the "[About the Open Source Initiative](http://opensource.org/about)" on the Open Source Initiative.
|
||||
|
||||
For more information about applying open source principles to your organization's development work on {% data variables.product.product_location %}, see {% data variables.product.prodname_dotcom %}'s white paper "[An introduction to innersource](https://resources.github.com/whitepapers/introduction-to-innersource/)."
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
|
||||
When creating your public repository from a fork of someone's project, make sure to include a license file that determines how you want your project to be shared with others. For more information, see "[Choose an open source license](https://choosealicense.com/)" at choosealicense.com.
|
||||
|
||||
{% data reusables.open-source.open-source-guide-repositories %} {% data reusables.open-source.open-source-learning-lab %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note**: {% data reusables.repositories.desktop-fork %}
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
|
||||
{% tip %}
|
||||
|
||||
**Tip**: You can also fork a repository using the {% data variables.product.prodname_cli %}. For more information, see "[`gh repo fork`](https://cli.github.com/manual/gh_repo_fork)" in the {% data variables.product.prodname_cli %} documentation.
|
||||
|
||||
{% endtip %}
|
||||
{% endif %}
|
||||
|
||||
### Fork an example repository
|
||||
|
||||
Forking a repository is a simple two-step process. We've created a repository for you to practice with.
|
||||
|
||||
1. On {% data variables.product.product_location %}, navigate to the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository.
|
||||
2. In the top-right corner of the page, click **Fork**.
|
||||
|
||||
|
||||
### Keep your fork synced
|
||||
|
||||
You might fork a project to propose changes to the upstream, or original, repository. In this case, it's good practice to regularly sync your fork with the upstream repository. To do this, you'll need to use Git on the command line. You can practice setting the upstream repository using the same [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository you just forked.
|
||||
|
||||
#### Step 1: Set up Git
|
||||
|
||||
If you haven't yet, you should first [set up Git](/articles/set-up-git). Don't forget to [set up authentication to {% data variables.product.product_location %} from Git](/articles/set-up-git#next-steps-authenticating-with-github-from-git) as well.
|
||||
|
||||
#### Step 2: Create a local clone of your fork
|
||||
|
||||
Right now, you have a fork of the Spoon-Knife repository, but you don't have the files in that repository on your computer. Let's create a clone of your fork locally on your computer.
|
||||
|
||||
1. On {% data variables.product.product_name %}, navigate to **your fork** of the Spoon-Knife repository.
|
||||
{% data reusables.repositories.copy-clone-url %}
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
{% data reusables.command_line.change-current-directory-clone %}
|
||||
4. Type `git clone`, and then paste the URL you copied earlier. It will look like this, with your {% data variables.product.product_name %} username instead of `YOUR-USERNAME`:
|
||||
```shell
|
||||
$ git clone https://{% data variables.command_line.codeblock %}/<em>YOUR-USERNAME</em>/Spoon-Knife
|
||||
```
|
||||
|
||||
5. Press **Enter**. Your local clone will be created.
|
||||
```shell
|
||||
$ git clone https://{% data variables.command_line.codeblock %}/<em>YOUR-USERNAME</em>/Spoon-Knife
|
||||
> Cloning into `Spoon-Knife`...
|
||||
> remote: Counting objects: 10, done.
|
||||
> remote: Compressing objects: 100% (8/8), done.
|
||||
> remove: Total 10 (delta 1), reused 10 (delta 1)
|
||||
> Unpacking objects: 100% (10/10), done.
|
||||
```
|
||||
|
||||
Now, you have a local copy of your fork of the Spoon-Knife repository.
|
||||
|
||||
#### Step 3: Configure Git to sync your fork with the original Spoon-Knife repository
|
||||
|
||||
When you fork a project in order to propose changes to the original repository, you can configure Git to pull changes from the original, or upstream, repository into the local clone of your fork.
|
||||
|
||||
1. On {% data variables.product.product_name %}, navigate to the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository.
|
||||
{% data reusables.repositories.copy-clone-url %}
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
4. Change directories to the location of the fork you cloned in [Step 2: Create a local clone of your fork](#step-2-create-a-local-clone-of-your-fork).
|
||||
- To go to your home directory, type just `cd` with no other text.
|
||||
- To list the files and folders in your current directory, type `ls`.
|
||||
- To go into one of your listed directories, type `cd your_listed_directory`.
|
||||
- To go up one directory, type `cd ..`.
|
||||
5. Type `git remote -v` and press **Enter**. You'll see the current configured remote repository for your fork.
|
||||
```shell
|
||||
$ git remote -v
|
||||
> origin https://{% data variables.command_line.codeblock %}/<em>YOUR_USERNAME</em>/<em>YOUR_FORK</em>.git (fetch)
|
||||
> origin https://{% data variables.command_line.codeblock %}/<em>YOUR_USERNAME</em>/<em>YOUR_FORK</em>.git (push)
|
||||
```
|
||||
|
||||
6. Type `git remote add upstream`, and then paste the URL you copied in Step 2 and press **Enter**. It will look like this:
|
||||
```shell
|
||||
$ git remote add upstream https://{% data variables.command_line.codeblock %}/octocat/Spoon-Knife.git
|
||||
```
|
||||
|
||||
7. To verify the new upstream repository you've specified for your fork, type `git remote -v` again. You should see the URL for your fork as `origin`, and the URL for the original repository as `upstream`.
|
||||
```shell
|
||||
$ git remote -v
|
||||
> origin https://{% data variables.command_line.codeblock %}/<em>YOUR_USERNAME</em>/<em>YOUR_FORK</em>.git (fetch)
|
||||
> origin https://{% data variables.command_line.codeblock %}/<em>YOUR_USERNAME</em>/<em>YOUR_FORK</em>.git (push)
|
||||
> upstream https://{% data variables.command_line.codeblock %}/<em>ORIGINAL_OWNER</em>/<em>ORIGINAL_REPOSITORY</em>.git (fetch)
|
||||
> upstream https://{% data variables.command_line.codeblock %}/<em>ORIGINAL_OWNER</em>/<em>ORIGINAL_REPOSITORY</em>.git (push)
|
||||
```
|
||||
|
||||
Now, you can keep your fork synced with the upstream repository with a few Git commands. For more information, see "[Syncing a fork](/articles/syncing-a-fork)."
|
||||
|
||||
#### Next steps
|
||||
|
||||
You can make any changes to a fork, including:
|
||||
|
||||
- **Creating branches:** [*Branches*](/articles/creating-and-deleting-branches-within-your-repository/) allow you to build new features or test out ideas without putting your main project at risk.
|
||||
- **Opening pull requests:** If you are hoping to contribute back to the original repository, you can send a request to the original author to pull your fork into their repository by submitting a [pull request](/articles/about-pull-requests).
|
||||
|
||||
### Find another repository to fork
|
||||
|
||||
Fork a repository to start contributing to a project. {% data reusables.repositories.you-can-fork %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}You can browse [Explore](https://github.com/explore) to find projects and start contributing to open source repositories. For more information, see "[Finding ways to contribute to open source on {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
### Celebrate
|
||||
|
||||
You have now forked a repository, practiced cloning your fork, and configured an upstream repository. What do you want to do next?
|
||||
|
||||
- "[Set up Git](/articles/set-up-git)"
|
||||
- "[Create a repository](/articles/create-a-repo)"
|
||||
- **Fork a repository**
|
||||
- "[Be social](/articles/be-social)"
|
||||
- {% data reusables.support.connect-in-the-forum-bootcamp %}
|
||||
@@ -0,0 +1,60 @@
|
||||
---
|
||||
title: Git and GitHub learning resources
|
||||
redirect_from:
|
||||
- /articles/good-resources-for-learning-git-and-github/
|
||||
- /articles/what-are-other-good-resources-for-learning-git-and-github/
|
||||
- /articles/git-and-github-learning-resources
|
||||
- /github/getting-started-with-github/git-and-github-learning-resources
|
||||
intro: 'There are a lot of helpful Git and {% data variables.product.product_name %} resources on the web. This is a short list of our favorites!'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
authors:
|
||||
- GitHub
|
||||
---
|
||||
### Using Git
|
||||
|
||||
Familiarize yourself with Git by visiting the [official Git project site](https://git-scm.com) and reading the [ProGit book](http://git-scm.com/book). You can review the [Git command list](https://git-scm.com/docs) or [Git command lookup reference](http://gitref.org) while using the [Try Git](https://try.github.com) simulator.
|
||||
|
||||
### Using {% data variables.product.product_name %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
|
||||
{% data variables.product.prodname_learning %} offers free interactive courses that are built into {% data variables.product.prodname_dotcom %} with instant automated feedback and help. Learn to open your first pull request, make your first open source contribution, create a {% data variables.product.prodname_pages %} site, and more. For more information about course offerings, see [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}).
|
||||
|
||||
{% endif %}
|
||||
|
||||
Become better acquainted with {% data variables.product.product_name %} through our [getting started](/categories/getting-started-with-github/) articles. See our [{% data variables.product.prodname_dotcom %} flow](https://guides.github.com/introduction/flow) for a process introduction. Refer to our [overview guides](https://guides.github.com) to walk through basic concepts.
|
||||
|
||||
{% data reusables.support.ask-and-answer-forum %}
|
||||
|
||||
#### Branches, forks, and pull requests
|
||||
|
||||
Learn about [Git branching](http://learngitbranching.js.org/) using an interactive tool. Read about [forks](/articles/about-forks) and [pull requests](/articles/using-pull-requests) as well as [how we use pull requests](https://github.com/blog/1124-how-we-use-pull-requests-to-build-github) at {% data variables.product.prodname_dotcom %}. Access references about using {% data variables.product.prodname_dotcom %} from the [command line](https://cli.github.com/).
|
||||
|
||||
#### Tune in
|
||||
|
||||
Our {% data variables.product.prodname_dotcom %} [YouTube Training and Guides channel](https://youtube.com/githubguides) offers tutorials about [pull requests](https://www.youtube.com/watch?v=d5wpJ5VimSU&list=PLg7s6cbtAD15G8lNyoaYDuKZSKyJrgwB-&index=19), [forking](https://www.youtube.com/watch?v=5oJHRbqEofs), [rebase](https://www.youtube.com/watch?v=SxzjZtJwOgo&list=PLg7s6cbtAD15G8lNyoaYDuKZSKyJrgwB-&index=22), and [reset](https://www.youtube.com/watch?v=BKPjPMVB81g) functions. Each topic is covered in 5 minutes or less.
|
||||
|
||||
### Training
|
||||
|
||||
#### Free courses
|
||||
|
||||
{% data variables.product.product_name %} offers a series of interactive, [on-demand training courses](https://lab.github.com/) including [Introduction to {% data variables.product.prodname_dotcom %}](https://lab.github.com/githubtraining/introduction-to-github); courses on programming languages and tools such as HTML, Python, and NodeJS; and courses on {% data variables.product.product_name %} specific tools such as {% data variables.product.prodname_actions %}.
|
||||
|
||||
#### {% data variables.product.prodname_dotcom %}'s web-based educational programs
|
||||
|
||||
{% data variables.product.prodname_dotcom %} offers live [trainings](https://services.github.com/#upcoming-events) with a hands-on, project-based approach for those who love the command line and those who don't.
|
||||
|
||||
#### Training for your company
|
||||
|
||||
{% data variables.product.prodname_dotcom %} offers [in-person classes](https://services.github.com/#offerings) taught by our highly-experienced educators. [Contact us](https://services.github.com/#contact) to ask your training-related questions.
|
||||
|
||||
### Extras
|
||||
|
||||
An interactive [online Git course](http://www.codeschool.com/courses/git-real) from [Code School](http://codeschool.com) has seven levels with dozens of exercises in a fun game format. Feel free to adapt our [.gitignore templates](https://github.com/github/gitignore) to meet your needs.
|
||||
|
||||
Extend your {% data variables.product.prodname_dotcom %} reach through {% if currentVersion == "free-pro-team@latest" %}[integrations](/articles/about-integrations){% else %}integrations{% endif %}, or by installing [{% data variables.product.prodname_desktop %}](https://desktop.github.com) and the robust [Atom](https://atom.io) text editor.
|
||||
|
||||
Learn how to launch and grow your open source project with the [Open Source Guides](https://opensource.guide/).
|
||||
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: Git cheatsheet
|
||||
redirect_from:
|
||||
- /articles/git-cheatsheet
|
||||
- /github/getting-started-with-github/git-cheatsheet
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
intro: This Git cheat sheet is a time saver when you forget a command or don't want to use help in the CLI.
|
||||
---
|
||||
Learning all available Git commands at once can be a daunting task. You can use "[Git Cheat Sheets](https://training.github.com/)" for a quick reference to frequently used commands. The "Using Git" cheat sheet is available in several languages.
|
||||
|
||||
In addition, take a look at our [Git and GitHub learning resources](/articles/git-and-github-learning-resources/) page that links to guides, videos and more.
|
||||
@@ -0,0 +1,99 @@
|
||||
---
|
||||
title: GitHub flow
|
||||
intro: 'Follow {% data variables.product.prodname_dotcom %} flow to collaborate on projects.'
|
||||
redirect_from:
|
||||
- /articles/creating-and-editing-files-in-your-repository/
|
||||
- /articles/github-flow-in-the-browser/
|
||||
- /articles/github-flow
|
||||
- /github/collaborating-with-issues-and-pull-requests/github-flow
|
||||
- /github/getting-started-with-github/github-flow
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- Pull requests
|
||||
- Fundamentals
|
||||
miniTocMaxHeadingLevel: 4
|
||||
---
|
||||
### Introduction
|
||||
|
||||
{% data variables.product.prodname_dotcom %} flow is a lightweight, branch-based workflow. The {% data variables.product.prodname_dotcom %} flow is useful for everyone, not just developers. For example, here at {% data variables.product.prodname_dotcom %}, we use {% data variables.product.prodname_dotcom %} flow for our [site policy](https://github.com/github/site-policy), [documentation](https://github.com/github/docs), and [roadmap](https://github.com/github/roadmap).
|
||||
|
||||
### Prerequisites
|
||||
|
||||
To follow {% data variables.product.prodname_dotcom %} flow, you will need {% data variables.product.prodname_dotcom %} account and a repository. For information on how to create an account, see "[Signing up for {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/signing-up-for-github)." For information on how to create a repository, see "[Create a repo](/github/getting-started-with-github/create-a-repo)."{% if currentVersion == "free-pro-team@latest" %} For information on how to find an existing repository to contribute to, see "[Finding ways to contribute to open source on {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)."{% endif %}
|
||||
|
||||
### Following {% data variables.product.prodname_dotcom %} flow
|
||||
|
||||
{% tip %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
**Tip:** You can complete all steps of {% data variables.product.prodname_dotcom %} flow through {% data variables.product.prodname_dotcom %} web interface, command line and [{% data variables.product.prodname_cli %}](https://cli.github.com), or [{% data variables.product.prodname_desktop %}](/desktop).
|
||||
{% else %}
|
||||
**Tip:** You can complete all steps of {% data variables.product.prodname_dotcom %} flow through {% data variables.product.prodname_dotcom %} web interface or through the command line and [{% data variables.product.prodname_cli %}](https://cli.github.com).
|
||||
{% endif %}
|
||||
|
||||
{% endtip %}
|
||||
|
||||
#### Create a branch
|
||||
|
||||
Create a branch in your repository. A short, descriptive branch name enables your collaborators to see ongoing work at a glance. For example, `increase-test-timeout` or `add-code-of-conduct`. For more information, see "[Creating and deleting branches within your repository](/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository)."
|
||||
|
||||
By creating a branch, you create a space to work without affecting the default branch. Additionally, you give collaborators a chance to review your work.
|
||||
|
||||
#### Make changes
|
||||
|
||||
On your branch, make any desired changes to the repository. For more information, see "[Creating new files](/articles/creating-new-files)," "[Editing files](/articles/editing-files)," "[Renaming a file](/articles/renaming-a-file)," "[Moving a file to a new location](/articles/moving-a-file-to-a-new-location)," or "[Deleting files in a repository](/github/managing-files-in-a-repository/deleting-files-in-a-repository)."
|
||||
|
||||
Your branch is a safe place to make changes. If you make a mistake, you can revert your changes or push additional changes to fix the mistake. Your changes will not end up on the default branch until you merge your branch.
|
||||
|
||||
Commit and push your changes to your branch. Give each commit a descriptive message to help you and future contributors understand what changes the commit contains. For example, `fix typo` or `increase rate limit`.
|
||||
|
||||
Ideally, each commit contains an isolated, complete change. This makes it easy to revert your changes if you decide to take a different approach. For example, if you want to rename a variable and add some tests, put the variable rename in one commit and the tests in another commit. Later, if you want to keep the tests but revert the variable rename, you can revert the specific commit that contained the variable rename. If you put the variable rename and tests in the same commit or spread the variable rename across multiple commits, you would spend more effort reverting your changes.
|
||||
|
||||
By committing and pushing your changes, you back up your work to remote storage. This means that you can access your work from any device. It also means that your collaborators can see your work, answer questions, and make suggestions or contributions.
|
||||
|
||||
Continue to make, commit, and push changes to your branch until you are ready to ask for feedback.
|
||||
|
||||
{% tip %}
|
||||
|
||||
**Tip:** Make a separate branch for each set of unrelated changes. This makes it easier for reviewers to give feedback. It also makes it easier for you and future collaborators to understand the changes and to revert or build on them. Additionally, if there is a delay in one set of changes, your other changes aren't also delayed.
|
||||
|
||||
{% endtip %}
|
||||
|
||||
#### Create a pull request
|
||||
|
||||
Create a pull request to ask collaborators for feedback on your changes. Pull request review is so valuable that some repositories require an approving review before pull requests can be merged. If you want early feedback or advice before you complete your changes, you can mark your pull request as a draft. For more information, see "[Creating a pull request](/articles/creating-a-pull-request)."
|
||||
|
||||
When you create a pull request, include a summary of the changes and what problem they solve. You can include images, links, and tables to help convey this information. If your pull request addresses an issue, link the issue so that issue stakeholders are aware of the pull request and vice versa. If you link with a keyword, the issue will close automatically when the pull request merges. For more information, see "[Basic writing and formatting syntax](/github/writing-on-github/basic-writing-and-formatting-syntax)" and "[Linking a pull request to an issue](/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue)."
|
||||
|
||||
|
||||
|
||||
In addition to filling out the body of the pull request, you can add comments to specific lines of the pull request to explicitly point something out to the reviewers.
|
||||
|
||||
|
||||
|
||||
Your repository may be configured to automatically request a review from specific teams or users when a pull request is created. You can also manually @mention or request a review from specific people or teams.
|
||||
|
||||
If your repository has checks configured to run on pull requests, you will see any checks that failed on your pull request. This helps you catch errors before merging your branch. For more information, see "[About status checks](/github/collaborating-with-issues-and-pull-requests/about-status-checks)."
|
||||
|
||||
#### Address review comments
|
||||
|
||||
Reviewers should leave questions, comments, and suggestions. Reviewers can comment on the whole pull request or add comments to specific lines. You and reviewers can insert images or code suggestions to clarify comments. For more information, see "[Reviewing changes in pull requests](/github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests)."
|
||||
|
||||
You can continue to commit and push changes in response to the reviews. Your pull request will update automatically.
|
||||
|
||||
#### Merge your pull request
|
||||
|
||||
Once your pull request is approved, merge your pull request. This will automatically merge your branch so that your changes appear on the default branch. {% data variables.product.prodname_dotcom %} retains the history of comments and commits in the pull request to help future contributors understand your changes. For more information, see "[Merging a pull request](/articles/merging-a-pull-request)."
|
||||
|
||||
{% data variables.product.prodname_dotcom %} will tell you if your pull request has conflicts that must be resolved before merging. For more information, see "[Addressing merge conflicts](/github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts)."
|
||||
|
||||
Branch protection settings may block merging if your pull request does not meet certain requirements. For example, you need a certain number of approving reviews or an approving review from a specific team. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches)."
|
||||
|
||||
#### Delete your branch
|
||||
|
||||
After you merge your pull request, delete your branch. This indicates that the work on the branch is complete and prevents you or others from accidentally using old branches. For more information, see "[Deleting and restoring branches in a pull request](/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request)."
|
||||
|
||||
Don't worry about losing information. Your pull request and commit history will not be deleted. You can always restore your deleted branch or revert your pull request if needed.
|
||||
@@ -0,0 +1,24 @@
|
||||
---
|
||||
title: GitHub glossary
|
||||
intro: 'Below are a list of some Git and {% data variables.product.prodname_dotcom %} specific terms we use across our sites and documentation.'
|
||||
redirect_from:
|
||||
- /articles/github-glossary
|
||||
- /github/getting-started-with-github/github-glossary
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
---
|
||||
{% for term in site.data.glossaries.external %}
|
||||
### {% data glossaries.external[forloop.index0].term %}
|
||||
{% data glossaries.external[forloop.index0].description %}
|
||||
---
|
||||
{% endfor %}
|
||||
|
||||
---
|
||||
|
||||
### Further reading
|
||||
|
||||
- [The Official Git Glossary](https://www.kernel.org/pub/software/scm/git/docs/gitglossary.html)
|
||||
- [Git Reference](http://gitref.org/)
|
||||
- [Git SCM](https://git-scm.com/doc)
|
||||
@@ -0,0 +1,23 @@
|
||||
---
|
||||
title: Quickstart
|
||||
intro: 'Quickly get started with common tasks on {% data variables.product.prodname_dotcom %}.'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- Pull requests
|
||||
- Issues
|
||||
- Notifications
|
||||
- Accounts
|
||||
children:
|
||||
- /set-up-git
|
||||
- /create-a-repo
|
||||
- /fork-a-repo
|
||||
- /github-flow
|
||||
- /be-social
|
||||
- /github-glossary
|
||||
- /git-cheatsheet
|
||||
- /git-and-github-learning-resources
|
||||
---
|
||||
|
||||
@@ -0,0 +1,64 @@
|
||||
---
|
||||
title: Set up Git
|
||||
redirect_from:
|
||||
- /git-installation-redirect/
|
||||
- /linux-git-installation/
|
||||
- /linux-set-up-git/
|
||||
- /mac-git-installation/
|
||||
- /mac-set-up-git/
|
||||
- /set-up-git-redirect/
|
||||
- /win-git-installation/
|
||||
- /win-set-up-git/
|
||||
- /articles/set-up-git
|
||||
- /github/getting-started-with-github/set-up-git
|
||||
intro: 'At the heart of {% data variables.product.product_name %} is an open source version control system (VCS) called Git. Git is responsible for everything {% data variables.product.product_name %}-related that happens locally on your computer.'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- Pull requests
|
||||
- Issues
|
||||
- Notifications
|
||||
- Accounts
|
||||
---
|
||||
### Using Git
|
||||
|
||||
To use Git on the command line, you'll need to download, install, and configure Git on your computer. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} You can also install {% data variables.product.prodname_cli %} to use {% data variables.product.product_name %} from the command line. For more information on {% data variables.product.prodname_cli %}, see the [{% data variables.product.prodname_cli %}](https://cli.github.com/manual/) documentation.{% endif %}
|
||||
|
||||
If you want to work with Git locally, but don't want to use the command line, you can instead download and install the [{% data variables.product.prodname_desktop %}]({% data variables.product.desktop_link %}) client. For more information, see "[Installing and configuring {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/)."
|
||||
|
||||
If you don't need to work with files locally, {% data variables.product.product_name %} lets you complete many Git-related actions directly in the browser, including:
|
||||
|
||||
- [Creating a repository](/articles/create-a-repo)
|
||||
- [Forking a repository](/articles/fork-a-repo)
|
||||
- [Managing files](/articles/managing-files-on-github/)
|
||||
- [Being social](/articles/be-social)
|
||||
|
||||
### Setting up Git
|
||||
|
||||
1. [Download and install the latest version of Git](https://git-scm.com/downloads).
|
||||
2. [Set your username in Git](/github/getting-started-with-github/setting-your-username-in-git).
|
||||
3. [Set your commit email address in Git](/articles/setting-your-commit-email-address).
|
||||
|
||||
### Next steps: Authenticating with {% data variables.product.prodname_dotcom %} from Git
|
||||
|
||||
When you connect to a {% data variables.product.product_name %} repository from Git, you'll need to authenticate with {% data variables.product.product_name %} using either HTTPS or SSH.
|
||||
|
||||
#### Connecting over HTTPS (recommended)
|
||||
|
||||
If you [clone with HTTPS](/github/getting-started-with-github/about-remote-repositories/#cloning-with-https-urls), you can [cache your {% data variables.product.prodname_dotcom %} credentials in Git](/github/getting-started-with-github/caching-your-github-credentials-in-git) using a credential helper.
|
||||
|
||||
#### Connecting over SSH
|
||||
|
||||
If you [clone with SSH](/github/getting-started-with-github/about-remote-repositories/#cloning-with-ssh-urls), you must [generate SSH keys](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) on each computer you use to push or pull from {% data variables.product.product_name %}.
|
||||
|
||||
### Celebrate
|
||||
|
||||
Congratulations, you now have Git and {% data variables.product.product_name %} all set up! What do you want to do next?
|
||||
|
||||
- **Set up Git**
|
||||
- "[Create a repository](/articles/create-a-repo)"
|
||||
- "[Fork a repository](/articles/fork-a-repo)"
|
||||
- "[Be social](/articles/be-social)"
|
||||
- {% data reusables.support.connect-in-the-forum-bootcamp %}
|
||||
Reference in New Issue
Block a user