jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-22 19:34:15 -05:00
Code Issues Projects Releases Wiki Activity

updating content files

Browse Source
This commit is contained in:
Grace Park
2021-06-14 12:06:52 -07:00
parent 850ab9ccb4
commit 6f7e4f50dc
1154 changed files with 6299 additions and 6267 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
content/github/getting-started-with-github/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github.md
View File

@@ -14,7 +14,7 @@ versions:
topics:
- Open Source
---
### Discovering relevant projects
## Discovering relevant projects
If there's a particular topic that interests you, visit `github.com/topics/<topic>`. For example, if you are interested in machine learning, you can find relevant projects and good first issues by visiting https://github.com/topics/machine-learning. You can browse popular topics by visiting [Topics](https://github.com/topics). You can also search for repositories that match a topic you're interested in. For more information, see "[Searching for repositories](/articles/searching-for-repositories#search-by-topic)."
@@ -24,29 +24,29 @@ Keep up with recent activity from repositories you watch and people you follow i
{% data reusables.support.ask-and-answer-forum %}
### Finding good first issues
## Finding good first issues
If you already know what project you want to work on, you can find beginner-friendly issues in that repository by visiting `github.com/<owner>/<repository>/contribute`. For an example, you can find ways to make your first contribution to `electron/electron` at https://github.com/electron/electron/contribute.
### Opening an issue
## Opening an issue
If you encounter a bug in an open source project, check if the bug has already been reported. If the bug has not been reported, you can open an issue to report the bug according to the project's contribution guidelines.
### Validating an issue or pull request
## Validating an issue or pull request
There are a variety of ways that you can contribute to open source projects.
#### Reproducing a reported bug
### Reproducing a reported bug
You can contribute to an open source project by validating an issue or adding additional context to an existing issue.
#### Testing a pull request
### Testing a pull request
You can contribute to an open source project by merging a pull request into your local copy of the project and testing the changes. Add the outcome of your testing in a comment on the pull request.
#### Updating issues
### Updating issues
You can contribute to an open source project by adding additional information to existing issues.
### Further reading
## Further reading
- "[Classifying your repository with topics](/articles/classifying-your-repository-with-topics)"
- "[About your organization dashboard](/articles/about-your-organization-dashboard)"

2
content/github/getting-started-with-github/exploring-projects-on-github/following-people.md
View File

@@ -18,7 +18,7 @@ When you follow people, you'll see their public activity in the activity view of
To stop following someone, visit their profile page and click **Unfollow** under their profile image.
{% if currentVersion == "free-pro-team@latest" %}
### Further reading
## Further reading
- "[Saving repositories with stars](/articles/saving-repositories-with-stars/)"
- "[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)"

10
content/github/getting-started-with-github/exploring-projects-on-github/saving-repositories-with-stars.md
View File

@@ -17,7 +17,7 @@ topics:
---
You can search, sort, and filter your starred repositories and topics on your {% data variables.explore.your_stars_page %}.
### About stars
## About stars
Starring makes it easy to find a repository or topic again later. You can see all the repositories and topics you have starred by going to your {% data variables.explore.your_stars_page %}.
@@ -27,7 +27,7 @@ You can star repositories and topics to discover similar projects on {% data var
Starring a repository also shows appreciation to the repository maintainer for their work. Many of {% data variables.product.prodname_dotcom %}'s repository rankings depend on the number of stars a repository has. In addition, [Explore](https://github.com/explore) shows popular repositories based on the number of stars they have.
### Starring a repository
## Starring a repository
Starring a repository is a simple two-step process.
@@ -37,7 +37,7 @@ Starring a repository is a simple two-step process.
1. Optionally, to unstar a previously starred repository, click **Unstar**.
![Untarring a repository](/assets/images/help/stars/unstarring-a-repository.png)
### Searching stars
## Searching stars
You can use the search bar on your {% data variables.explore.your_stars_page %} to quickly find repositories and topics you've starred.
@@ -47,7 +47,7 @@ You can use the search bar on your {% data variables.explore.your_stars_page %}
The search bar only searches based on the name of a repository or topic, and not on any other qualifiers (such as the size of the repository or when it was last updated).
### Sorting and filtering stars
## Sorting and filtering stars
You can use sorting or filtering to customize how you see starred repositories and topics on your stars page.
@@ -59,6 +59,6 @@ You can use sorting or filtering to customize how you see starred repositories a
1. To filter your list of stars based on repository or topic, click on the desired option.
![Filter stars by topic](/assets/images/help/stars/stars_filter_topic.png)
### Further reading
## Further reading
- "[Classifying your repository with topics](/articles/classifying-your-repository-with-topics)"

14
content/github/getting-started-with-github/getting-started-with-git/about-remote-repositories.md
View File

@@ -15,7 +15,7 @@ versions:
enterprise-server: '*'
github-ae: '*'
---
### About remote repositories
## About remote repositories
A remote URL is Git's fancy way of saying "the place where your code is stored." That URL could be your repository on GitHub, or another user's fork, or even on a completely different server.
@@ -26,7 +26,7 @@ You can only push to two types of URL addresses:
Git associates a remote URL with a name, and your default remote is usually called `origin`.
### Creating remote repositories
## Creating remote repositories
You can use the `git remote add` command to match a remote URL with a name.
For example, you'd type the following in the command line:
@@ -39,7 +39,7 @@ This associates the name `origin` with the `REMOTE_URL`.
You can use the command `git remote set-url` to [change a remote's URL](/github/getting-started-with-github/managing-remote-repositories).
### Choosing a URL for your remote repository
## Choosing a URL for your remote repository
There are several ways to clone repositories available on {% data variables.product.product_location %}.
@@ -47,7 +47,7 @@ When you view a repository while signed in to your account, the URLs you can use
For information on setting or changing your remote URL, see "[Managing remote repositories](/github/getting-started-with-github/managing-remote-repositories)."
### Cloning with HTTPS URLs
## Cloning with HTTPS URLs
The `https://` clone URLs are available on all repositories, regardless of visibility. `https://` clone URLs work even if you are behind a firewall or proxy.
@@ -65,7 +65,7 @@ When you `git clone`, `git fetch`, `git pull`, or `git push` to a remote reposit
{% if currentVersion == "free-pro-team@latest" %}If you'd rather use SSH but cannot connect over port 22, you might be able to use SSH over the HTTPS port. For more information, see "[Using SSH over the HTTPS port](/github/authenticating-to-github/using-ssh-over-the-https-port)."{% endif %}
### Cloning with SSH URLs
## Cloning with SSH URLs
SSH URLs provide access to a Git repository via SSH, a secure protocol. To use these URLs, you must generate an SSH keypair on your computer and add the **public** key to your {% data variables.product.product_name %} account. For more information, see "[Connecting to {% data variables.product.prodname_dotcom %} with SSH](/github/authenticating-to-github/connecting-to-github-with-ssh)."
@@ -81,14 +81,14 @@ When you `git clone`, `git fetch`, `git pull`, or `git push` to a remote reposit
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
### Cloning with {% data variables.product.prodname_cli %}
## Cloning with {% data variables.product.prodname_cli %}
You can also install {% data variables.product.prodname_cli %} to use {% data variables.product.product_name %} workflows in your terminal. For more information, the [{% data variables.product.prodname_cli %}](https://cli.github.com/manual/) documentation.
{% endif %}
{% if currentVersion != "github-ae@latest" %}
### Cloning with Subversion
## Cloning with Subversion
You can also use a [Subversion](https://subversion.apache.org/) client to access any repository on {% data variables.product.prodname_dotcom %}. Subversion offers a different feature set than Git. For more information, see "[What are the differences between Subversion and Git?](/github/importing-your-projects-to-github/what-are-the-differences-between-subversion-and-git)"

22
content/github/getting-started-with-github/getting-started-with-git/associating-text-editors-with-git.md
View File

@@ -15,7 +15,7 @@ versions:
---
{% mac %}
### Using Atom as your editor
## Using Atom as your editor
1. Install [Atom](https://atom.io/). For more information, see "[Installing Atom](https://flight-manual.atom.io/getting-started/sections/installing-atom/)" in the Atom documentation.
{% data reusables.command_line.open_the_multi_os_terminal %}
@@ -24,7 +24,7 @@ versions:
$ git config --global core.editor "atom --wait"
```
### Using Visual Studio Code as your editor
## Using Visual Studio Code as your editor
1. Install [Visual Studio Code](https://code.visualstudio.com/) (VS Code). For more information, see "[Setting up Visual Studio Code](https://code.visualstudio.com/Docs/setup/setup-overview)" in the VS Code documentation.
{% data reusables.command_line.open_the_multi_os_terminal %}
@@ -33,7 +33,7 @@ versions:
$ git config --global core.editor "code --wait"
```
### Using Sublime Text as your editor
## Using Sublime Text as your editor
1. Install [Sublime Text](https://www.sublimetext.com/). For more information, see "[Installation](https://docs.sublimetext.io/guide/getting-started/installation.html)" in the Sublime Text documentation.
{% data reusables.command_line.open_the_multi_os_terminal %}
@@ -42,7 +42,7 @@ versions:
$ git config --global core.editor "subl -n -w"
```
### Using TextMate as your editor
## Using TextMate as your editor
1. Install [TextMate](https://macromates.com/).
2. Install TextMate's `mate` shell utility. For more information, see "[mate and rmate](https://macromates.com/blog/2011/mate-and-rmate/)" in the TextMate documentation.
@@ -55,7 +55,7 @@ versions:
{% windows %}
### Using Atom as your editor
## Using Atom as your editor
1. Install [Atom](https://atom.io/). For more information, see "[Installing Atom](https://flight-manual.atom.io/getting-started/sections/installing-atom/)" in the Atom documentation.
3. Type this command:
@@ -63,7 +63,7 @@ versions:
$ git config --global core.editor "atom --wait"
```
### Using Visual Studio Code as your editor
## Using Visual Studio Code as your editor
1. Install [Visual Studio Code](https://code.visualstudio.com/) (VS Code). For more information, see "[Setting up Visual Studio Code](https://code.visualstudio.com/Docs/setup/setup-overview)" in the VS Code documentation.
{% data reusables.command_line.open_the_multi_os_terminal %}
@@ -72,7 +72,7 @@ versions:
$ git config --global core.editor "code --wait"
```
### Using Sublime Text as your editor
## Using Sublime Text as your editor
1. Install [Sublime Text](https://www.sublimetext.com/). For more information, see "[Installation](https://docs.sublimetext.io/guide/getting-started/installation.html)" in the Sublime Text documentation.
{% data reusables.command_line.open_the_multi_os_terminal %}
@@ -81,7 +81,7 @@ versions:
$ git config --global core.editor "'C:/Program Files (x86)/sublime text 3/subl.exe' -w"
```
### Using Notepad++ as your editor
## Using Notepad++ as your editor
1. Install Notepad++ from https://notepad-plus-plus.org/. For more information, see "[Getting started](https://npp-user-manual.org/docs/getting-started/)" in the Notepad++ documentation.
{% data reusables.command_line.open_the_multi_os_terminal %}
@@ -93,7 +93,7 @@ versions:
{% linux %}
### Using Atom as your editor
## Using Atom as your editor
1. Install [Atom](https://atom.io/). For more information, see "[Installing Atom](https://flight-manual.atom.io/getting-started/sections/installing-atom/)" in the Atom documentation.
{% data reusables.command_line.open_the_multi_os_terminal %}
@@ -102,7 +102,7 @@ versions:
$ git config --global core.editor "atom --wait"
```
### Using Visual Studio Code as your editor
## Using Visual Studio Code as your editor
1. Install [Visual Studio Code](https://code.visualstudio.com/) (VS Code). For more information, see "[Setting up Visual Studio Code](https://code.visualstudio.com/Docs/setup/setup-overview)" in the VS Code documentation.
{% data reusables.command_line.open_the_multi_os_terminal %}
@@ -111,7 +111,7 @@ versions:
$ git config --global core.editor "code --wait"
```
### Using Sublime Text as your editor
## Using Sublime Text as your editor
1. Install [Sublime Text](https://www.sublimetext.com/). For more information, see "[Installation](https://docs.sublimetext.io/guide/getting-started/installation.html)" in the Sublime Text documentation.
{% data reusables.command_line.open_the_multi_os_terminal %}

2
content/github/getting-started-with-github/getting-started-with-git/caching-your-github-credentials-in-git.md
View File

@@ -99,7 +99,7 @@ For more options for storing your credentials on Linux, see [Credential Storage]
{% endlinux %}
### Further reading
## Further reading
- "[Updating credentials from the OSX Keychain](/articles/updating-credentials-from-the-osx-keychain/)"
- "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)"

10
content/github/getting-started-with-github/getting-started-with-git/configuring-git-to-handle-line-endings.md
View File

@@ -19,7 +19,7 @@ When you're collaborating on projects with Git and {% data variables.product.pro
You can configure Git to handle line endings automatically so you can collaborate effectively with people who use different operating systems.
### Global settings for line endings
## Global settings for line endings
The `git config core.autocrlf` command is used to change how Git handles line endings. It takes a single argument.
@@ -57,7 +57,7 @@ $ git config --global core.autocrlf input
{% endlinux %}
### Per-repository settings
## Per-repository settings
Optionally, you can configure a *.gitattributes* file to manage how Git reads line endings in a specific repository. When you commit this file to a repository, it overrides the `core.autocrlf` setting for all repository contributors. This ensures consistent behavior for all users, regardless of their Git settings and environment.
@@ -68,7 +68,7 @@ A *.gitattributes* file looks like a table with two columns:
* On the left is the file name for Git to match.
* On the right is the line ending configuration that Git should use for those files.
#### Example
### Example
Here's an example *.gitattributes* file. You can use it as a template for your repositories:
@@ -99,7 +99,7 @@ You'll notice that files are matched—`*.c`, `*.sln`, `*.png`—, separated by
- `binary` Git will understand that the files specified are not text, and it should not try to change them. The `binary` setting is also an alias for `-text -diff`.
### Refreshing a repository after changing line endings
## Refreshing a repository after changing line endings
When you set the `core.autocrlf` option or commit a *.gitattributes* file, you may find that Git reports changes to files that you have not modified. Git has changed line endings to match your new configuration.
@@ -123,7 +123,7 @@ To ensure that all the line endings in your repository match your new configurat
$ git commit -m "Normalize all the line endings"
```
### Further reading
## Further reading
- [Customizing Git - Git Attributes](https://git-scm.com/book/en/Customizing-Git-Git-Attributes) in the Pro Git book
- [git-config](https://git-scm.com/docs/git-config) in the man pages for Git

8
content/github/getting-started-with-github/getting-started-with-git/ignoring-files.md
View File

@@ -12,7 +12,7 @@ versions:
enterprise-server: '*'
github-ae: '*'
---
### Configuring ignored files for a single repository
## Configuring ignored files for a single repository
You can create a *.gitignore* file in your repository's root directory to tell Git which files and directories to ignore when you make a commit.
To share the ignore rules with other users who clone the repository, commit the *.gitignore* file in to your repository.
@@ -34,7 +34,7 @@ If you want to ignore a file that is already checked in, you must untrack the fi
$ git rm --cached <em>FILENAME</em>
```
### Configuring ignored files for all repositories on your computer
## Configuring ignored files for all repositories on your computer
You can also create a global *.gitignore* file to define a list of rules for ignoring files in every Git repository on your computer. For example, you might create the file at *~/.gitignore_global* and add some rules to it.
@@ -44,7 +44,7 @@ You can also create a global *.gitignore* file to define a list of rules for ign
$ git config --global core.excludesfile ~/.gitignore_global
```
### Excluding local files without creating a *.gitignore* file
## Excluding local files without creating a *.gitignore* file
If you don't want to create a *.gitignore* file to share with others, you can create rules that are not committed with the repository. You can use this technique for locally-generated files that you don't expect other users to generate, such as files created by your editor.
@@ -54,7 +54,7 @@ Use your favorite text editor to open the file called *.git/info/exclude* within
2. Navigate to the location of your Git repository.
3. Using your favorite text editor, open the file *.git/info/exclude*.
### Further Reading
## Further Reading
* [Ignoring files](https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository#_ignoring) in the Pro Git book
* [.gitignore](https://git-scm.com/docs/gitignore) in the man pages for Git

28
content/github/getting-started-with-github/getting-started-with-git/managing-remote-repositories.md
View File

@@ -22,7 +22,7 @@ versions:
enterprise-server: '*'
github-ae: '*'
---
### Adding a remote repository
## Adding a remote repository
To add a new remote, use the `git remote add` command on the terminal, in the directory your repository is stored at.
@@ -44,7 +44,7 @@ $ git remote -v
For more information on which URL to use, see "[About remote repositories](/github/getting-started-with-github/about-remote-repositories)."
#### Troubleshooting: Remote origin already exists
### Troubleshooting: Remote origin already exists
This error means you've tried to add a remote with a name that already exists in your local repository.
@@ -58,7 +58,7 @@ To fix this, you can:
* Rename the existing remote repository
* Delete the existing remote repository
### Changing a remote repository's URL
## Changing a remote repository's URL
The `git remote set-url` command changes an existing remote repository URL.
@@ -81,7 +81,7 @@ https://{% data variables.command_line.backticks %}/<em>USERNAME</em>/<em>REPOSI
git@{% data variables.command_line.codeblock %}:<em>USERNAME</em>/<em>REPOSITORY</em>.git
```
#### Switching remote URLs from SSH to HTTPS
### Switching remote URLs from SSH to HTTPS
{% data reusables.command_line.open_the_multi_os_terminal %}
2. Change the current working directory to your local project.
@@ -107,7 +107,7 @@ The next time you `git fetch`, `git pull`, or `git push` to the remote repositor
You can [use a credential helper](/github/getting-started-with-github/caching-your-github-credentials-in-git) so Git will remember your GitHub username and personal access token every time it talks to GitHub.
#### Switching remote URLs from HTTPS to SSH
### Switching remote URLs from HTTPS to SSH
{% data reusables.command_line.open_the_multi_os_terminal %}
2. Change the current working directory to your local project.
@@ -129,7 +129,7 @@ You can [use a credential helper](/github/getting-started-with-github/caching-yo
> origin git@{% data variables.command_line.codeblock %}:<em>USERNAME/REPOSITORY</em>.git (push)
```
#### Troubleshooting: No such remote '[name]'
### Troubleshooting: No such remote '[name]'
This error means that the remote you tried to change doesn't exist:
@@ -140,7 +140,7 @@ $ git remote set-url sofake https://{% data variables.command_line.codeblock %}/
Check that you've correctly typed the remote name.
### Renaming a remote repository
## Renaming a remote repository
Use the `git remote rename` command to rename an existing remote.
@@ -148,7 +148,7 @@ The `git remote rename` command takes two arguments:
* An existing remote name, for example, `origin`
* A new name for the remote, for example, `destination`
### Example
## Example
These examples assume you're [cloning using HTTPS](/github/getting-started-with-github/about-remote-repositories/#cloning-with-https-urls), which is recommended.
@@ -167,7 +167,7 @@ $ git remote -v
> destination https://{% data variables.command_line.codeblock %}/<em>OWNER</em>/<em>REPOSITORY</em>.git (push)
```
#### Troubleshooting: Could not rename config section 'remote.[old name]' to 'remote.[new name]'
### Troubleshooting: Could not rename config section 'remote.[old name]' to 'remote.[new name]'
This error means that the remote you tried the old remote name you typed doesn't exist.
@@ -180,18 +180,18 @@ $ git remote -v
> origin https://{% data variables.command_line.codeblock %}/<em>OWNER</em>/<em>REPOSITORY</em>.git (push)
```
#### Troubleshooting: Remote [new name] already exists
### Troubleshooting: Remote [new name] already exists
This error means that the remote name you want to use already exists. To solve this, either use a different remote name, or rename the original remote.
### Removing a remote repository
## Removing a remote repository
Use the `git remote rm` command to remove a remote URL from your repository.
The `git remote rm` command takes one argument:
* A remote name, for example, `destination`
### Example
## Example
These examples assume you're [cloning using HTTPS](/github/getting-started-with-github/about-remote-repositories/#cloning-with-https-urls), which is recommended.
@@ -218,7 +218,7 @@ removes the remote and its references from your local repository.
{% endwarning %}
#### Troubleshooting: Could not remove config section 'remote.[name]'
### Troubleshooting: Could not remove config section 'remote.[name]'
This error means that the remote you tried to delete doesn't exist:
@@ -229,6 +229,6 @@ $ git remote rm sofake
Check that you've correctly typed the remote name.
### Further reading
## Further reading
- "[Working with Remotes" from the _Pro Git_ book](https://git-scm.com/book/en/Git-Basics-Working-with-Remotes)

6
content/github/getting-started-with-github/getting-started-with-git/setting-your-username-in-git.md
View File

@@ -14,7 +14,7 @@ You can change the name that is associated with your Git commits using the `git
Changing the name associated with your Git commits using `git config` will only affect future commits and will not change the name used for past commits.
### Setting your Git username for *every* repository on your computer
## Setting your Git username for *every* repository on your computer
{% data reusables.command_line.open_the_multi_os_terminal %}
@@ -29,7 +29,7 @@ Changing the name associated with your Git commits using `git config` will only
> Mona Lisa
```
### Setting your Git username for a single repository
## Setting your Git username for a single repository
{% data reusables.command_line.open_the_multi_os_terminal %}
@@ -46,7 +46,7 @@ Changing the name associated with your Git commits using `git config` will only
> Mona Lisa
```
### Further reading
## Further reading
- "[Setting your commit email address](/articles/setting-your-commit-email-address)"
- ["Git Configuration" from the _Pro Git_ book](https://git-scm.com/book/en/Customizing-Git-Git-Configuration)

6
content/github/getting-started-with-github/getting-started-with-git/updating-credentials-from-the-macos-keychain.md
View File

@@ -13,7 +13,7 @@ versions:
---
{% data reusables.user_settings.password-authentication-deprecation %}
### Updating your credentials via Keychain Access
## Updating your credentials via Keychain Access
1. Click on the Spotlight icon (magnifying glass) on the right side of the menu bar. Type `Keychain access` then press the Enter key to launch the app.
![Spotlight Search bar](/assets/images/help/setup/keychain-access.png)
@@ -21,7 +21,7 @@ versions:
3. Find the "internet password" entry for `{% data variables.command_line.backticks %}`.
4. Edit or delete the entry accordingly.
### Deleting your credentials via the command line
## Deleting your credentials via the command line
Through the command line, you can use the credential helper directly to erase the keychain entry.
@@ -34,6 +34,6 @@ protocol=https
If it's successful, nothing will print out. To test that it works, try and clone a private repository from {% data variables.product.product_location %}. If you are prompted for a password, the keychain entry was deleted.
### Further reading
## Further reading
- "[Caching your {% data variables.product.prodname_dotcom %} credentials in Git](/github/getting-started-with-github/caching-your-github-credentials-in-git/)"

2
content/github/getting-started-with-github/getting-started-with-git/why-is-git-always-asking-for-my-password.md
View File

@@ -16,7 +16,7 @@ Using an HTTPS remote URL has some advantages compared with using SSH. It's easi
You can avoid being prompted for your password by configuring Git to [cache your credentials](/github/getting-started-with-github/caching-your-github-credentials-in-git) for you. Once you've configured credential caching, Git automatically uses your cached personal access token when you pull or push a repository using HTTPS.
### Further reading
## Further reading
- "[About remote repositories](/github/getting-started-with-github/about-remote-repositories)."
- "[About authentication to {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/about-authentication-to-github)"

12
content/github/getting-started-with-github/learning-about-github/about-github-advanced-security.md
View File

@@ -11,13 +11,13 @@ topics:
redirect_from:
- /github/getting-started-with-github/about-github-advanced-security
---
### About {% data variables.product.prodname_GH_advanced_security %}
## About {% data variables.product.prodname_GH_advanced_security %}
{% data variables.product.prodname_dotcom %} has many features that help you improve and maintain the quality of your code. Some of these are included in all plans{% if currentVersion != "github-ae@latest" %}, such as dependency graph and {% data variables.product.prodname_dependabot_alerts %}{% endif %}. Other security features require a license for {% data variables.product.prodname_GH_advanced_security %} to run on repositories apart from public repositories on {% data variables.product.prodname_dotcom_the_website %}.
{% if currentVersion == "free-pro-team@latest" %}For more information, see "[About licensing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-licensing-for-github-advanced-security/about-licensing-for-github-advanced-security)."{% elsif currentVersion ver_gt "enterprise-server@2.22" %}For information about purchasing a license for {% data variables.product.prodname_GH_advanced_security %}, contact {% data variables.contact.contact_enterprise_sales %}.{% elsif currentVersion == "github-ae@latest" %}There is no charge for {% data variables.product.prodname_GH_advanced_security %} on {% data variables.product.prodname_ghe_managed %} during the beta release.{% endif %}
### About {% data variables.product.prodname_advanced_security %} features
## About {% data variables.product.prodname_advanced_security %} features
A {% data variables.product.prodname_GH_advanced_security %} license provides the following additional features:
@@ -32,7 +32,7 @@ A {% data variables.product.prodname_GH_advanced_security %} license provides th
For information about {% data variables.product.prodname_advanced_security %} features that are in development, see "[{% data variables.product.prodname_dotcom %} public roadmap](https://github.com/github/roadmap)." For an overview of all security features, see "[{% data variables.product.prodname_dotcom %} security features](/code-security/getting-started/github-security-features)."
{% if currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
### Enabling {% data variables.product.prodname_advanced_security %} features on {% data variables.product.product_name %}
## Enabling {% data variables.product.prodname_advanced_security %} features on {% data variables.product.product_name %}
{% if currentVersion ver_gt "enterprise-server@2.22" %}
The site administrator must enable {% data variables.product.prodname_advanced_security %} for {% data variables.product.product_location %} before you can use these features. For more information, see "[Configuring Advanced Security features](/admin/configuration/configuring-advanced-security-features)."
@@ -43,7 +43,7 @@ Once your system is set up, you can enable and disable these features at the org
{% endif %}
{% if currentVersion != "github-ae@latest" %}
### Enabling {% data variables.product.prodname_advanced_security %} features on {% data variables.product.prodname_dotcom_the_website %}
## Enabling {% data variables.product.prodname_advanced_security %} features on {% data variables.product.prodname_dotcom_the_website %}
For public repositories on {% data variables.product.prodname_dotcom_the_website %}, these features are permanently on and can only be disabled if you change the visibility of the project so that the code is no longer public.
@@ -58,13 +58,13 @@ If you have an enterprise account, license use for the entire enterprise is show
{% if currentVersion == "free-pro-team@latest" %}
### Further reading
## Further reading
- "[Enforcing policies for {% data variables.product.prodname_advanced_security %} in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-policies-for-advanced-security-in-your-enterprise-account)"
{% elsif currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@next" %}
### Further reading
## Further reading
- "[Enforcing policies for {% data variables.product.prodname_advanced_security %} in your enterprise](/admin/policies/enforcing-policies-for-advanced-security-in-your-enterprise)"

8
content/github/getting-started-with-github/learning-about-github/access-permissions-on-github.md
View File

@@ -15,11 +15,11 @@ topics:
- Permissions
- Accounts
---
### Personal user accounts
## Personal user accounts
A repository owned by a user account has two permission levels: the *repository owner* and *collaborators*. For more information, see "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository)."
### Organization accounts
## Organization accounts
Organization members can have *owner*{% if currentVersion == "free-pro-team@latest" %}, *billing manager*,{% endif %} or *member* roles. Owners have complete administrative access to your organization{% if currentVersion == "free-pro-team@latest" %}, while billing managers can manage billing settings{% endif %}. Member is the default role for everyone else. You can manage access permissions for multiple members at a time with teams. For more information, see:
- "[Permission levels for an organization](/articles/permission-levels-for-an-organization)"
@@ -29,7 +29,7 @@ Organization members can have *owner*{% if currentVersion == "free-pro-team@late
{% if currentVersion == "free-pro-team@latest" %}
### Enterprise accounts
## Enterprise accounts
*Enterprise owners* have ultimate power over the enterprise account and can take every action in the enterprise account. *Billing managers* can manage your enterprise account's billing settings. Members and outside collaborators of organizations owned by your enterprise account are automatically members of the enterprise account, although they have no access to the enterprise account itself or its settings. For more information, see "[Roles in an enterprise](/github/setting-up-and-managing-your-enterprise/roles-in-an-enterprise)."
@@ -37,6 +37,6 @@ Organization members can have *owner*{% if currentVersion == "free-pro-team@late
{% endif %}
### Further reading
## Further reading
- "[Types of {% data variables.product.prodname_dotcom %} accounts](/articles/types-of-github-accounts)"

32
content/github/getting-started-with-github/learning-about-github/faq-about-changes-to-githubs-plans.md
View File

@@ -8,7 +8,7 @@ topics:
redirect_from:
- /github/getting-started-with-github/faq-about-changes-to-githubs-plans
---
### What plans and pricing changes did GitHub announce on April 14?
## What plans and pricing changes did GitHub announce on April 14?
GitHub announced the following plans and pricing changes:
@@ -22,15 +22,15 @@ GitHub announced the following plans and pricing changes:
- GitHub Team no longer has a required five-seat minimum
- GitHub Team includes 3,000 Actions minutes per month for private repositories
### How can I upgrade my plan?
## How can I upgrade my plan?
To upgrade your user account's plan, see "[Upgrading your personal account's subscription](/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription#upgrading-your-personal-accounts-subscription)." To upgrade your organization's plan, see "[Upgrading your organization's subscription](/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription#upgrading-your-organizations-subscription)."
### How can I downgrade my plan?
## How can I downgrade my plan?
To downgrade your user account's plan, see "[Downgrading your user account's subscription](/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription#downgrading-your-user-accounts-subscription)." To downgrade your organization's plan, see "[Downgrading your organization's subscription](/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription#downgrading-your-organizations-subscription)."
### If I downgrade from GitHub Team or a Legacy plan to GitHub Free, what features will I lose?
## If I downgrade from GitHub Team or a Legacy plan to GitHub Free, what features will I lose?
- Required reviewers in private repositories
- Protected branches in private repositories
- Code owners in private repositories
@@ -42,51 +42,51 @@ To downgrade your user account's plan, see "[Downgrading your user account's sub
- Autolinked references in private repositories
- Standard support
### How can I create a GitHub Free or GitHub Team organization?
## How can I create a GitHub Free or GitHub Team organization?
If you have a GitHub account, create a new organization on our [team plan page](https://github.com/organizations/plan). If you don’t have a GitHub account, you can [create one on our homepage](https://github.com/) and you’ll be prompted to create an organization during the sign-up process.
### How can I compare which features are in each plan?
## How can I compare which features are in each plan?
You can see pricing and a full list of features for each product at <{% data variables.product.pricing_url %}>.
### How long will GitHub Free allow unlimited collaborators?
## How long will GitHub Free allow unlimited collaborators?
Forever! This change is permanent.
### I already paid for the yearly Pro or Team plan, do I get a refund for the price difference?
## I already paid for the yearly Pro or Team plan, do I get a refund for the price difference?
Customers who are currently paying annually for Pro and Team plans and signed up before April 14 will receive a refund for a prorated amount through the end of their annual billing term. For example, if you are two months into your subscription that is billed annually, you will receive a refund for the price difference for the remaining ten months. These refunds will be processed in approximately 30 days. Once your refund is processed, a notification will be sent to the billing email.
### What is the difference between GitHub Free for individual developers and GitHub Free for organizations?
## What is the difference between GitHub Free for individual developers and GitHub Free for organizations?
For details on the differences for each GitHub Free product, see "[{% data variables.product.prodname_dotcom %}'s products](/articles/github-s-products)."
### How can I get more Actions minutes if I need more than allocated in the GitHub Team plan?
## How can I get more Actions minutes if I need more than allocated in the GitHub Team plan?
Most small teams use fewer than 3,000 Actions minutes/month, but some teams might use more. If your team needs additional minutes for private repositories, you can increase your spending limit for GitHub Actions. Actions minutes and Packages storage are still free for your public repositories. For more information, see "[Managing your spending limit for GitHub Actions](/billing/managing-billing-for-github-actions/managing-your-spending-limit-for-github-actions)."
### How do the seat limit changes affect me?
## How do the seat limit changes affect me?
Now that {% data variables.product.prodname_team %} has no minimum seat requirement, if you are using fewer than five seats in your organization, you can remove paid seats to reduce your bill. For more information, see "[Downgrading your {% data variables.product.prodname_dotcom %} subscription](/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription#removing-paid-seats-from-your-organization)."
### Is anything changing for teams on the GitHub Team for Open Source plan?
## Is anything changing for teams on the GitHub Team for Open Source plan?
If your organization account currently uses the GitHub Team for Open Source plan, you’ve been automatically moved to GitHub Free, which includes private repositories with unlimited collaborators, 2,000 Actions minutes for private repositories, and GitHub Community Support. Actions minutes and Packages storage are still free for your public repositories.
### What is GitHub Community Support?
## What is GitHub Community Support?
GitHub Community Support includes support through our [Community Forum](https://github.community/), where you can browse solutions from the GitHub community, ask new questions, and share ideas. GitHub Community Support is staffed by Support Engineers on the GitHub Team, who moderate the Community Forum along with our most active community members. If you need to report spam, report abuse, or have issues with account access, you can send a message to our Support Team on https://support.github.com/.
### How does this change affect education benefits?
## How does this change affect education benefits?
Students and teachers will continue to receive all of the benefits they get today. GitHub will continue to offer GitHub Pro as part of its [Student Developer Pack](https://education.github.com/pack) benefits to all students. Additionally, teachers will continue to have access to GitHub Team as part of the [Teacher Toolbox](https://education.github.com/toolbox).
### How does this affect me if I currently pay by invoice?
## How does this affect me if I currently pay by invoice?
If you’re currently an invoice customer, email your sales representative for additional details. If you’re not sure who your sales representative is, contact your billing manager or account owner.
### How will this impact users and organizations in regions where U.S. government sanctions are applied?
## How will this impact users and organizations in regions where U.S. government sanctions are applied?
Due to U.S. trade controls law restrictions, GitHub is unable to provide private repository services and paid services to accounts in U.S. sanctioned regions. GitHub has preserved, however, access to free public repository services. Please read about [GitHub and Trade Controls](/github/site-policy/github-and-trade-controls) for more information.

4
content/github/getting-started-with-github/learning-about-github/github-language-support.md
View File

@@ -12,13 +12,13 @@ redirect_from:
---
<!-- If you make changes to this article, also update any feature-level articles to reflect the same changes in language support. -->
### About supported languages
## About supported languages
Most {% data variables.product.prodname_dotcom %} features work regardless of which languages your code is written in. You can search for code or enable syntax highlighting based on any language known to {% data variables.product.prodname_dotcom %}. For more information, see "[Searching code](/github/searching-for-information-on-github/searching-code#search-by-language)" or "[Creating and highlighting code blocks](/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting)."
Some {% data variables.product.prodname_dotcom %} products have features that are currently only supported for a subset of programming languages.
### Core languages supported by {% data variables.product.prodname_dotcom %} features
## Core languages supported by {% data variables.product.prodname_dotcom %} features
Core languages for {% data variables.product.prodname_dotcom %} features include C, C++, C#, Go, Java, JavaScript, PHP, Python, Ruby, Scala, and TypeScript. For features that support package managers, the currently supported package managers are included in the table with their relevant languages.

12
content/github/getting-started-with-github/learning-about-github/githubs-products.md
View File

@@ -16,11 +16,11 @@ topics:
- Desktop
- Security
---
### About {% data variables.product.prodname_dotcom %}'s products
## About {% data variables.product.prodname_dotcom %}'s products
{% data variables.product.prodname_dotcom %} offers free and paid products. You can see pricing and a full list of features for each product at <{% data variables.product.pricing_url %}>. {% data reusables.products.product-roadmap %}
### {% data variables.product.prodname_free_user %} for user accounts
## {% data variables.product.prodname_free_user %} for user accounts
With {% data variables.product.prodname_free_team %} for user accounts, you can work with unlimited collaborators on unlimited public repositories with a full feature set, and on unlimited private repositories with a limited feature set.
@@ -31,7 +31,7 @@ With {% data variables.product.prodname_free_user %}, your user account includes
- 2,000 {% data variables.product.prodname_actions %} minutes
- 500MB {% data variables.product.prodname_registry %} storage
### {% data variables.product.prodname_pro %}
## {% data variables.product.prodname_pro %}
In addition to the features available with {% data variables.product.prodname_free_user %} for user accounts, {% data variables.product.prodname_pro %} includes:
- {% data variables.contact.github_support %} via email
@@ -47,7 +47,7 @@ In addition to the features available with {% data variables.product.prodname_fr
- Code owners
- Repository insights graphs: Pulse, contributors, traffic, commits, code frequency, network, and forks
### {% data variables.product.prodname_free_team %} for organizations
## {% data variables.product.prodname_free_team %} for organizations
With {% data variables.product.prodname_free_team %} for organizations, you can work with unlimited collaborators on unlimited public repositories with a full feature set, or unlimited private repositories with a limited feature set.
@@ -58,7 +58,7 @@ In addition to the features available with {% data variables.product.prodname_fr
- 2,000 {% data variables.product.prodname_actions %} minutes
- 500MB {% data variables.product.prodname_registry %} storage
### {% data variables.product.prodname_team %}
## {% data variables.product.prodname_team %}
In addition to the features available with {% data variables.product.prodname_free_team %} for organizations, {% data variables.product.prodname_team %} includes:
- {% data variables.contact.github_support %} via email
@@ -78,7 +78,7 @@ In addition to the features available with {% data variables.product.prodname_fr
{% data reusables.github-actions.actions-billing %}
### {% data variables.product.prodname_enterprise %}
## {% data variables.product.prodname_enterprise %}
{% data variables.product.prodname_enterprise %} includes two deployment options: cloud-hosted and self-hosted.

8
content/github/getting-started-with-github/learning-about-github/types-of-github-accounts.md
View File

@@ -23,7 +23,7 @@ topics:
For a full list of features for each {% data variables.product.product_name %} product, see "[{% data variables.product.prodname_dotcom %}'s products](/github/getting-started-with-github/githubs-products)."
{% endif %}
### Personal user accounts
## Personal user accounts
Every person who uses {% data variables.product.product_location %} has their own user account, which includes:
@@ -62,7 +62,7 @@ Every person who uses {% data variables.product.product_location %} has their ow
{% endif %}
### Organization accounts
## Organization accounts
Organizations are shared accounts where groups of people can collaborate across many projects at once. Owners and administrators can manage member access to the organization's data and projects with sophisticated security and administrative features.
@@ -70,13 +70,13 @@ Organizations are shared accounts where groups of people can collaborate across
{% if currentVersion == "free-pro-team@latest" %}
### Enterprise accounts
## Enterprise accounts
With enterprise accounts, you can centrally manage policy and billing for multiple {% data variables.product.prodname_dotcom_the_website %} organizations. {% data reusables.gated-features.enterprise-accounts %}
{% endif %}
### Further reading
## Further reading
{% if currentVersion == "free-pro-team@latest" %}- "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/articles/signing-up-for-a-new-github-account)"
- "[{% data variables.product.prodname_dotcom %}'s products](/articles/githubs-products)"{% endif %}

20
content/github/getting-started-with-github/quickstart/be-social.md
View File

@@ -18,7 +18,7 @@ topics:
---
To learn about accessing your personal dashboard, see "[About your personal dashboard](/articles/about-your-personal-dashboard)."
### Following people
## 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)."
@@ -26,7 +26,7 @@ Click **Follow** on a person's profile page to follow them.
![Follow user button](/assets/images/help/profile/follow-user-button.png)
### Watching a repository
## 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 %}."
@@ -34,39 +34,39 @@ Click **Watch** at the top of a repository to watch it.
![Watch repository button](/assets/images/help/repository/repo-actions-watch.png)
### Joining the conversation
## Joining the conversation
{% data reusables.support.ask-and-answer-forum %}
### Communicating on {% data variables.product.product_name %}
## 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
## Doing even more
#### Creating pull requests
### 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)."
![Pull request button](/assets/images/help/repository/repo-actions-pullrequest.png)
#### Using issues
### 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/)."
![Issues button](/assets/images/help/repository/repo-tabs-issues.png)
#### Participating in organizations
### 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/)."
![Switch account context dropdown](/assets/images/help/overview/dashboard-contextswitcher.png)
#### Exploring other projects on {% data variables.product.prodname_dotcom %}
### 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
## Celebrate
You're now connected to the {% data variables.product.product_name %} community. What do you want to do next?

32
content/github/getting-started-with-github/quickstart/communicating-on-github.md
View File

@@ -1,7 +1,7 @@
---
title: Communicating on GitHub
intro: 'You can discuss specific projects and changes, as well as broader ideas or team goals, using different types of discussions on {% data variables.product.product_name %}.'
miniTocMaxHeadingLevel: 4
miniTocMaxHeadingLevel: 3
redirect_from:
- /github/collaborating-with-issues-and-pull-requests/getting-started/quickstart-for-communicating-on-github
- /articles/about-discussions-in-issues-and-pull-requests/
@@ -17,7 +17,7 @@ topics:
- Discussions
- Fundamentals
---
### Introduction
## Introduction
{% data variables.product.product_name %} provides built-in collaborative communication tools allowing you to interact closely with your community. This quickstart guide will show you how to pick the right tool for your needs.
@@ -28,18 +28,18 @@ You can create and participate in issues, pull requests, {% data variables.produ
You can create and participate in issues, pull requests and team discussions, depending on the type of conversation you'd like to have.
{% endif %}
#### Issues
### Issues
- are useful for discussing specific details of a project such as bug reports, planned improvements and feedback.
- are specific to a repository, and usually have a clear owner.
- are often referred to as {% data variables.product.prodname_dotcom %}'s bug-tracking system.
#### Pull requests
### Pull requests
- allow you to propose specific changes.
- allow you comment directly on proposed changes suggested by others.
- are specific to a repository.
{% if currentVersion == "free-pro-team@latest" %}
#### {% data variables.product.prodname_discussions %}
### {% data variables.product.prodname_discussions %}
- are like a forum, and are best used for open-form ideas and discussions where collaboration is important.
- may span many repositories.
- provide a collaborative experience outside the codebase, allowing the brainstorming of ideas, and the creation of a community knowledge base.
@@ -47,23 +47,23 @@ You can create and participate in issues, pull requests and team discussions, de
- often do not result in an actionable task.
{% endif %}
#### Team discussions
### Team discussions
- can be started on your team's page for conversations that span across projects and don't belong in a specific issue or pull request. Instead of opening an issue in a repository to discuss an idea, you can include the entire team by having a conversation in a team discussion.
- allow you to hold discussions with your team about planning, analysis, design, user research and general project decision making in one place.{% if currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
- provide a collaborative experience outside the codebase, allowing the brainstorming of ideas.
- often don’t have a clear owner.
- often do not result in an actionable task.{% endif %}
### Which discussion tool should I use?
## Which discussion tool should I use?
#### Scenarios for issues
### Scenarios for issues
- I want to keep track of tasks, enhancements and bugs.
- I want to file a bug report.
- I want to share feedback about a specific feature.
- I want to ask a question about files in the repository.
##### Issue example
#### Issue example
This example illustrates how a {% data variables.product.prodname_dotcom %} user created an issue in our documentation open source repository to make us aware of a bug, and discuss a fix.
@@ -74,14 +74,14 @@ This example illustrates how a {% data variables.product.prodname_dotcom %} user
- A discussion ensues, and eventually, a consensus will be reached about the fix to apply.
- A contributor can then create a pull request with the fix.
#### Scenarios for pull requests
### Scenarios for pull requests
- I want to fix a typo in a repository.
- I want to make changes to a repository.
- I want to make changes to fix an issue.
- I want to comment on changes suggested by others.
##### Pull request example
#### Pull request example
This example illustrates how a {% data variables.product.prodname_dotcom %} user created a pull request in our documentation open source repository to fix a typo.
@@ -98,14 +98,14 @@ The **Files changed** tab of the pull request shows the implemented fix.
- A repository maintainer reviews the pull request, comments on it, and merges it.
{% if currentVersion == "free-pro-team@latest" %}
#### Scenarios for {% data variables.product.prodname_discussions %}
### Scenarios for {% data variables.product.prodname_discussions %}
- I have a question that's not necessarily related to specific files in the repository.
- I want to share news with my collaborators, or my team.
- I want to start or participate in an open-ended conversation.
- I want to make an announcement to my community.
##### {% data variables.product.prodname_discussions %} example
#### {% data variables.product.prodname_discussions %} example
This example shows the {% data variables.product.prodname_discussions %} welcome post for the {% data variables.product.prodname_dotcom %} Docs open source repository, and illustrates how the team wants to collaborate with their community.
@@ -115,7 +115,7 @@ This community maintainer started a discussion to welcome the community, and to
{% endif %}
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
#### Scenarios for team discussions
### Scenarios for team discussions
- I have a question that's not necessarily related to specific files in the repository.
- I want to share news with my collaborators, or my team.
@@ -126,7 +126,7 @@ This community maintainer started a discussion to welcome the community, and to
As you can see, team discussions are very similar to {% data variables.product.prodname_discussions %}. For {% data variables.product.prodname_dotcom_the_website %}, we recommend using {% data variables.product.prodname_discussions %} as the starting point for conversations. You can use {% data variables.product.prodname_discussions %} to collaborate with any community on {% data variables.product.prodname_dotcom %}. If you are part of an organization, and would like to initiate conversations within your organization or team within that organization, you should use team discussions.
{% endif %}
##### Team discussion example
#### Team discussion example
This example shows a team post for the `octo-team` team.
@@ -139,7 +139,7 @@ The `octocat` team member posted a team discussion, informing the team of variou
{% endif %}
### Next steps
## Next steps
These examples showed you how to decide which is the best tool for your conversations on {% data variables.product.product_name %}. But this is only the beginning; there is so much more you can do to tailor these tools to your needs.

6
content/github/getting-started-with-github/quickstart/create-a-repo.md
View File

@@ -15,7 +15,7 @@ topics:
- Notifications
- Accounts
---
### Create a repository
## Create a repository
{% if currentVersion == "free-pro-team@latest" %}
@@ -56,7 +56,7 @@ Congratulations! You've successfully created your first repository, and initiali
{% endtip %}
{% endif %}
### Commit your first change
## 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.
@@ -76,7 +76,7 @@ Let's commit a change to the *README* file.
{% data reusables.files.choose_commit_branch %}
{% data reusables.files.propose_file_change %}
### Celebrate
## 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?

22
content/github/getting-started-with-github/quickstart/fork-a-repo.md
View File

@@ -16,11 +16,11 @@ topics:
- Notifications
- Accounts
---
### About forks
## 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. You can fork a repository to create a copy of the repository and make changes without affecting the upstream repository. For more information, see "[Working with forks](/github/collaborating-with-issues-and-pull-requests/working-with-forks)."
#### Propose changes to someone else's project
### 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:
@@ -28,7 +28,7 @@ For example, you can use forks to propose changes related to fixing a bug. Rathe
- Make the fix.
- Submit a pull request to the project owner.
#### Use someone else's project as a starting point for your own idea.
### 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.
@@ -56,7 +56,7 @@ When creating your public repository from a fork of someone's project, make sure
{% endtip %}
{% endif %}
### Fork an example repository
## Fork an example repository
Forking a repository is a simple two-step process. We've created a repository for you to practice with.
@@ -64,15 +64,15 @@ Forking a repository is a simple two-step process. We've created a repository fo
2. In the top-right corner of the page, click **Fork**.
![Fork button](/assets/images/help/repository/fork_button.jpg)
### Keep your fork synced
## 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
### 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
### 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.
@@ -96,7 +96,7 @@ Right now, you have a fork of the Spoon-Knife repository, but you don't have the
```
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
### 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.
@@ -131,21 +131,21 @@ When you fork a project in order to propose changes to the original repository,
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
### 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
## 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
## Celebrate
You have now forked a repository, practiced cloning your fork, and configured an upstream repository. What do you want to do next?

18
content/github/getting-started-with-github/quickstart/git-and-github-learning-resources.md
View File

@@ -13,11 +13,11 @@ versions:
authors:
- GitHub
---
### Using Git
## 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 %}
## Using {% data variables.product.product_name %}
{% if currentVersion == "free-pro-team@latest" %}
@@ -29,29 +29,29 @@ Become better acquainted with {% data variables.product.product_name %} through
{% data reusables.support.ask-and-answer-forum %}
#### Branches, forks, and pull requests
### 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
### 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
## Training
#### Free courses
### 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 %}'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
### 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
## 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.

20
content/github/getting-started-with-github/quickstart/github-flow.md
View File

@@ -14,17 +14,17 @@ versions:
topics:
- Pull requests
- Fundamentals
miniTocMaxHeadingLevel: 4
miniTocMaxHeadingLevel: 3
---
### Introduction
## 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
## 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
## Following {% data variables.product.prodname_dotcom %} flow
{% tip %}
@@ -36,13 +36,13 @@ To follow {% data variables.product.prodname_dotcom %} flow, you will need {% da
{% endtip %}
#### Create a branch
### 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
### 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)."
@@ -62,7 +62,7 @@ Continue to make, commit, and push changes to your branch until you are ready to
{% endtip %}
#### Create a pull request
### 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)."
@@ -78,13 +78,13 @@ Your repository may be configured to automatically request a review from specifi
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
### 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
### 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)."
@@ -92,7 +92,7 @@ Once your pull request is approved, merge your pull request. This will automatic
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
### 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)."

2
content/github/getting-started-with-github/quickstart/github-glossary.md
View File

@@ -17,7 +17,7 @@ versions:
---
### Further reading
## Further reading
- [The Official Git Glossary](https://www.kernel.org/pub/software/scm/git/docs/gitglossary.html)
- [Git Reference](http://gitref.org/)

12
content/github/getting-started-with-github/quickstart/set-up-git.md
View File

@@ -22,7 +22,7 @@ topics:
- Notifications
- Accounts
---
### Using Git
## 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 %}
@@ -35,25 +35,25 @@ If you don't need to work with files locally, {% data variables.product.product_
- [Managing files](/articles/managing-files-on-github/)
- [Being social](/articles/be-social)
### Setting up Git
## 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
## 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)
### 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
### 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
## Celebrate
Congratulations, you now have Git and {% data variables.product.product_name %} all set up! What do you want to do next?

10
content/github/getting-started-with-github/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md
View File

@@ -10,7 +10,7 @@ versions:
topics:
- Accounts
---
### About trials of {% data variables.product.prodname_ghe_cloud %}
## About trials of {% data variables.product.prodname_ghe_cloud %}
You can set up a 14-day trial to evaluate {% data variables.product.prodname_ghe_cloud %} on a new organization account. You do not need to provide a payment method during the trial unless you add {% data variables.product.prodname_marketplace %} apps to your organization that require a payment method. For more information, see "<a href="/articles/about-billing-for-github-marketplace/" class="dotcom-only">About billing for {% data variables.product.prodname_marketplace %}</a>."
@@ -20,7 +20,7 @@ Trials are also available for {% data variables.product.prodname_ghe_server %}.
{% data reusables.products.which-product-to-use %}
### Setting up your trial of {% data variables.product.prodname_ghe_cloud %}
## Setting up your trial of {% data variables.product.prodname_ghe_cloud %}
Before you can start your trial of {% data variables.product.prodname_ghe_cloud %}, you must have an existing user account or create a new user account. For more information, see "<a href="/articles/signing-up-for-a-new-github-account" class="dotcom-only">Signing up for a new {% data variables.product.prodname_dotcom %} account</a>."
@@ -42,13 +42,13 @@ Before you can start your trial of {% data variables.product.prodname_ghe_cloud
![Number of employees drop-down menu](/assets/images/help/organizations/employees-drop-down.png)
10. Review the <a href="/articles/github-enterprise-cloud-evaluation-agreement" class="dotcom-only">Evaluation License Agreement</a>, then click **Next**.
### Exploring {% data variables.product.prodname_ghe_cloud %}
## Exploring {% data variables.product.prodname_ghe_cloud %}
After setting up your trial, you can explore {% data variables.product.prodname_ghe_cloud %} by following the [Enterprise Onboarding Guide](https://resources.github.com/enterprise-onboarding/).
{% data reusables.products.product-roadmap %}
### Finishing your trial
## Finishing your trial
You can buy {% data variables.product.prodname_enterprise %} or downgrade to {% data variables.product.prodname_team %} at any time during your trial.
@@ -64,6 +64,6 @@ Downgrading to {% data variables.product.prodname_free_team %} for organizations
![Buy Enterprise and Downgrade to Team buttons](/assets/images/help/organizations/finish-trial-buttons.png)
6. Follow the prompts to enter your payment method, then click **Submit**.
### Further reading
## Further reading
- "[Setting up a trial of {% data variables.product.prodname_ghe_server %}](/articles/setting-up-a-trial-of-github-enterprise-server)"

10
content/github/getting-started-with-github/signing-up-for-github/setting-up-a-trial-of-github-enterprise-server.md
View File

@@ -11,7 +11,7 @@ versions:
topics:
- Accounts
---
### About trials of {% data variables.product.prodname_ghe_server %}
## About trials of {% data variables.product.prodname_ghe_server %}
You can request a 45-day trial to evaluate {% data variables.product.prodname_ghe_server %}. Your trial will be installed as a virtual appliance, with options for on-premises or cloud deployment. For a list of supported visualization platforms, see "[Setting up a GitHub Enterprise Server instance](/enterprise/admin/installation/setting-up-a-github-enterprise-server-instance)."
@@ -21,7 +21,7 @@ Trials are also available for {% data variables.product.prodname_ghe_cloud %}. F
{% data reusables.products.which-product-to-use %}
### Setting up your trial of {% data variables.product.prodname_ghe_server %}
## Setting up your trial of {% data variables.product.prodname_ghe_server %}
{% data variables.product.prodname_ghe_server %} is installed as a virtual appliance. Determine the best person in your organization to set up a virtual machine, and ask that person to submit a [trial request](https://enterprise.github.com/trial). You can begin your trial immediately after submitting a request.
@@ -29,7 +29,7 @@ To set up an account for the {% data variables.product.prodname_enterprise %} We
To install {% data variables.product.prodname_ghe_server %}, download the necessary components and upload your license file. For more information, see the instructions for your chosen visualization platform in "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/enterprise/admin/installation/setting-up-a-github-enterprise-server-instance)."
### Next steps
## Next steps
To get the most out of your trial, follow these steps:
@@ -52,12 +52,12 @@ To get the most out of your trial, follow these steps:
{% data reusables.products.product-roadmap %}
### Finishing your trial
## Finishing your trial
You can upgrade to full licenses in the [{% data variables.product.prodname_enterprise %} Web portal](https://enterprise.github.com/login) at any time during the trial period.
If you haven't upgraded by the last day of your trial, you'll receive an email notifying you that your trial had ended. If you need more time to evaluate {% data variables.product.prodname_enterprise %}, contact {% data variables.contact.contact_enterprise_sales %} to request an extension.
### Further reading
## Further reading
- "[Setting up a trial of {% data variables.product.prodname_ghe_cloud %}](/articles/setting-up-a-trial-of-github-enterprise-cloud)"

2
content/github/getting-started-with-github/signing-up-for-github/signing-up-for-a-new-github-account.md
View File

@@ -15,7 +15,7 @@ For more information about account types and products, see "[Types of {% data va
{% data reusables.accounts.create-account %}
1. Follow the prompts to create your personal account or organization.
### Next steps
## Next steps
- "[Verify your email address](/articles/verifying-your-email-address)"
- "[Configure two-factor authentication](/articles/configuring-two-factor-authentication)"

12
content/github/getting-started-with-github/signing-up-for-github/verifying-your-email-address.md
View File

@@ -11,7 +11,7 @@ versions:
topics:
- Accounts
---
### About email verification
## About email verification
You can verify your email address after signing up for a new account, or when you add a new email address. If an email address is undeliverable or bouncing, it will be unverified.
@@ -37,7 +37,7 @@ If you do not verify your email address, you will not be able to:
{% endwarning %}
### Verifying your email address
## Verifying your email address
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.emails %}
@@ -46,13 +46,13 @@ If you do not verify your email address, you will not be able to:
4. {% data variables.product.prodname_dotcom %} will send you an email with a link in it. After you click that link, you'll be taken to your {% data variables.product.prodname_dotcom %} dashboard and see a confirmation banner.
![Banner confirming that your email was verified](/assets/images/help/settings/email-verification-confirmation-banner.png)
### Troubleshooting email verification
## Troubleshooting email verification
#### Unable to send verification email
### Unable to send verification email
{% data reusables.user_settings.no-verification-disposable-emails %}
#### Error page after clicking verification link
### Error page after clicking verification link
The verification link expires after 24 hours. If you don't verify your email within 24 hours, you can request another email verification link. For more information, see "[Verifying your email address](/articles/verifying-your-email-address)."
@@ -63,6 +63,6 @@ If you click on the link in the confirmation email within 24 hours and you are d
3. {% data variables.product.signin_link %} to your personal {% data variables.product.prodname_dotcom %} account.
4. Click on the verification link in the email we sent you.
### Further reading
## Further reading
- "[Changing your primary email address](/articles/changing-your-primary-email-address)"

10
content/github/getting-started-with-github/using-git/about-git-rebase.md
View File

@@ -24,7 +24,7 @@ Typically, you would use `git rebase` to:
{% endwarning %}
### Rebasing commits against a branch
## Rebasing commits against a branch
To rebase all the commits between another branch and the current branch state, you can enter the following command in your shell (either the command prompt for Windows, or the terminal for Mac and Linux):
@@ -32,7 +32,7 @@ To rebase all the commits between another branch and the current branch state, y
$ git rebase --interactive <em>other_branch_name</em>
```
### Rebasing commits against a point in time
## Rebasing commits against a point in time
To rebase the last few commits in your current branch, you can enter the following command in your shell:
@@ -40,7 +40,7 @@ To rebase the last few commits in your current branch, you can enter the followi
$ git rebase --interactive HEAD~7
```
### Commands available while rebasing
## Commands available while rebasing
There are six commands available while rebasing:
@@ -64,7 +64,7 @@ There are six commands available while rebasing:
<dd>This lets you run arbitrary shell commands against a commit.</dd>
</dl>
### An example of using `git rebase`
## An example of using `git rebase`
No matter which command you use, Git will launch [your default text editor](/github/getting-started-with-github/associating-text-editors-with-git) and open a file that details the commits in the range you've chosen. That file looks something like this:
@@ -100,7 +100,7 @@ Breaking this information, from top to bottom, we see that:
- After the commits, Git tells you the range of commits we're working with (`41a72e6..7b36971`).
- Finally, Git gives some help by telling you the commands that are available to you when rebasing commits.
### Further reading
## Further reading
- "[Using Git rebase](/articles/using-git-rebase)"
- [The "Git Branching" chapter from the _Pro Git_ book](https://git-scm.com/book/en/Git-Branching-Rebasing)

10
content/github/getting-started-with-github/using-git/about-git-subtree-merges.md
View File

@@ -12,7 +12,7 @@ versions:
enterprise-server: '*'
github-ae: '*'
---
### About subtree merges
## About subtree merges
Typically, a subtree merge is used to contain a repository within a repository. The "subrepository" is stored in a folder of the main repository.
@@ -23,7 +23,7 @@ The best way to explain subtree merges is to show by example. We will:
- The `test` project will use that subproject as if it were part of the same repository.
- Fetch updates from `Spoon-Knife` into our `test` project.
### Setting up the empty repository for a subtree merge
## Setting up the empty repository for a subtree merge
{% data reusables.command_line.open_the_multi_os_terminal %}
2. Create a new directory and navigate to it.
@@ -46,7 +46,7 @@ The best way to explain subtree merges is to show by example. We will:
> create mode 100644 .gitignore
```
### Adding a new repository as a subtree
## Adding a new repository as a subtree
1. Add a new remote URL pointing to the separate project that we're interested in.
```shell
@@ -92,7 +92,7 @@ Although we've only added one subproject, any number of subprojects can be incor
{% endtip %}
### Synchronizing with updates and changes
## Synchronizing with updates and changes
When a subproject is added, it is not automatically kept in sync with the upstream changes. You will need to update the subproject with the following command:
@@ -106,7 +106,7 @@ For the example above, this would be:
$ git pull -s subtree spoon-knife main
```
### Further reading
## Further reading
- [The "Advanced Merging" chapter from the _Pro Git_ book](https://git-scm.com/book/en/v2/Git-Tools-Advanced-Merging)
- "[How to use the subtree merge strategy](https://www.kernel.org/pub/software/scm/git/docs/howto/using-merge-subtree.html)"

12
content/github/getting-started-with-github/using-git/getting-changes-from-a-remote-repository.md
View File

@@ -11,11 +11,11 @@ versions:
enterprise-server: '*'
github-ae: '*'
---
### Options for getting changes
## Options for getting changes
These commands are very useful when interacting with [a remote repository](/github/getting-started-with-github/about-remote-repositories). `clone` and `fetch` download remote code from a repository's remote URL to your local computer, `merge` is used to merge different people's work together with yours, and `pull` is a combination of `fetch` and `merge`.
### Cloning a repository
## Cloning a repository
To grab a complete copy of another user's repository, use `git clone` like this:
@@ -39,7 +39,7 @@ For every branch `foo` in the remote repository, a corresponding remote-tracking
`refs/remotes/origin/foo` is created in your local repository. You can usually abbreviate
such remote-tracking branch names to `origin/foo`.
### Fetching changes from a remote repository
## Fetching changes from a remote repository
Use `git fetch` to retrieve new work done by other people. Fetching from a repository grabs all the new remote-tracking branches and tags *without* merging those changes into your own branches.
@@ -52,7 +52,7 @@ $ git fetch <em>remotename</em>
Otherwise, you can always add a new remote and then fetch. For more information, see "[Managing remote repositories](/github/getting-started-with-github/managing-remote-repositories)."
### Merging changes into your local branch
## Merging changes into your local branch
Merging combines your local changes with changes made by others.
@@ -63,7 +63,7 @@ $ git merge <em>remotename</em>/<em>branchname</em>
# Merges updates made online with your local work
```
### Pulling changes from a remote repository
## Pulling changes from a remote repository
`git pull` is a convenient shortcut for completing both `git fetch` and `git merge `in the same command:
@@ -78,7 +78,7 @@ your local work is committed before running the `pull` command. If you run into
you cannot resolve, or if you decide to quit the merge, you can use `git merge --abort`
to take the branch back to where it was in before you pulled.
### Further reading
## Further reading
- ["Working with Remotes" from the _Pro Git_ book](https://git-scm.com/book/en/Git-Basics-Working-with-Remotes)"{% if currentVersion == "free-pro-team@latest" %}
- "[Troubleshooting connectivity problems](/articles/troubleshooting-connectivity-problems)"{% endif %}

12
content/github/getting-started-with-github/using-git/pushing-commits-to-a-remote-repository.md
View File

@@ -25,7 +25,7 @@ git push <em> &lt;REMOTENAME> &lt;BRANCHNAME> </em>
As an example, you usually run `git push origin main` to push your local changes
to your online repository.
### Renaming branches
## Renaming branches
To rename a branch, you'd use the same `git push` command, but you would add
one more argument: the name of the new branch. For example:
@@ -36,7 +36,7 @@ git push <em> &lt;REMOTENAME> &lt;LOCALBRANCHNAME></em>:<em>&lt;REMOTEBRANCHNAME
This pushes the `LOCALBRANCHNAME` to your `REMOTENAME`, but it is renamed to `REMOTEBRANCHNAME`.
### Dealing with "non-fast-forward" errors
## Dealing with "non-fast-forward" errors
If your local copy of a repository is out of sync with, or "behind," the upstream
repository you're pushing to, you'll get a message saying `non-fast-forward updates were rejected`.
@@ -45,7 +45,7 @@ you are able to push your local changes.
For more information on this error, see "[Dealing with non-fast-forward errors](/github/getting-started-with-github/dealing-with-non-fast-forward-errors)."
### Pushing tags
## Pushing tags
By default, and without additional parameters, `git push` sends all matching branches
that have the same names as remote branches.
@@ -62,7 +62,7 @@ To push all your tags, you can type the command:
git push <em> &lt;REMOTENAME></em> --tags
```
### Deleting a remote branch or tag
## Deleting a remote branch or tag
The syntax to delete a branch is a bit arcane at first glance:
@@ -75,7 +75,7 @@ you'd take to rename a branch. However, here, you're telling Git to push _nothin
into `BRANCHNAME` on `REMOTENAME`. Because of this, `git push` deletes the branch
on the remote repository.
### Remotes and forks
## Remotes and forks
You might already know that [you can "fork" repositories](https://guides.github.com/overviews/forking/) on GitHub.
@@ -106,7 +106,7 @@ and [initiate a pull request](/articles/about-pull-requests).
For more information on working with forks, see "[Syncing a fork](/articles/syncing-a-fork)".
### Further reading
## Further reading
- [The "Remotes" chapter from the "Pro Git" book](https://git-scm.com/book/ch5-2.html)
- [`git remote` man page](https://git-scm.com/docs/git-remote.html)

6
content/github/getting-started-with-github/using-git/using-git-rebase-on-the-command-line.md
View File

@@ -11,7 +11,7 @@ versions:
enterprise-server: '*'
github-ae: '*'
---
### Using Git rebase
## Using Git rebase
In this example, we will cover all of the `git rebase` commands available, except for `exec`.
@@ -122,7 +122,7 @@ i cant' typ goods
As before, Git is showing the commit message for you to edit. You can change the text (`"i cant' typ goods"`), save the file, and close the editor. Git will finish the rebase and return you to the terminal.
### Pushing rebased code to GitHub
## Pushing rebased code to GitHub
Since you've altered Git history, the usual `git push origin` **will not** work. You'll need to modify the command by "force-pushing" your latest changes:
@@ -140,6 +140,6 @@ Force pushing has serious implications because it changes the historical sequenc
{% endwarning %}
### Further reading
## Further reading
* "[Resolving merge conflicts after a Git rebase](/github/getting-started-with-github/resolving-merge-conflicts-after-a-git-rebase)"

4
content/github/getting-started-with-github/using-github/exploring-early-access-releases-with-feature-preview.md
View File

@@ -9,7 +9,7 @@ versions:
topics:
- Early access
---
### {% data variables.product.prodname_dotcom %}'s release cycle
## {% data variables.product.prodname_dotcom %}'s release cycle
{% data variables.product.product_name %}'s products and features can go through multiple release phases.
@@ -19,7 +19,7 @@ topics:
| Beta | The product or feature is ready for broader distribution. Beta releases can be public or private, are documented, but do not have any SLAs or technical support obligations. |
| General availability (GA) | The product or feature is fully tested and open publicly to all users. GA releases are ready for production use, and associated SLA and technical support obligations apply. |
### Exploring beta releases with feature preview
## Exploring beta releases with feature preview
You can see a list of features that are available in beta and a brief description for each feature. Each feature includes a link to give feedback.

6
content/github/getting-started-with-github/using-github/github-cli.md
View File

@@ -10,7 +10,7 @@ topics:
redirect_from:
- /github/getting-started-with-github/github-cli
---
### About {% data variables.product.prodname_cli %}
## About {% data variables.product.prodname_cli %}
{% data variables.product.prodname_cli %} is an open source tool for using {% data variables.product.product_name %} from your computer's command line. When you're working from the command line, you can use the {% data variables.product.prodname_cli %} to save time and avoid switching context.
@@ -25,10 +25,10 @@ The {% data variables.product.prodname_cli %} includes {% data variables.product
For more information about what you can do with {% data variables.product.prodname_cli %}, see the [{% data variables.product.prodname_cli %} manual](https://cli.github.com/manual).
### Installing {% data variables.product.prodname_cli %}
## Installing {% data variables.product.prodname_cli %}
View installation instructions {% data variables.product.prodname_cli %} for macOS, Windows, and Linux on the [{% data variables.product.prodname_cli %} page](https://cli.github.com).
### Sharing feedback
## Sharing feedback
If you have feedback or feature requests, you can open an issue in the [`cli/cli` repository](https://github.com/cli/cli).

4
content/github/getting-started-with-github/using-github/github-desktop.md
View File

@@ -10,12 +10,12 @@ topics:
redirect_from:
- /github/getting-started-with-github/github-desktop
---
### About {% data variables.product.prodname_desktop %}
## About {% data variables.product.prodname_desktop %}
{% data reusables.desktop.about-github-desktop %}
For more information about {% data variables.product.prodname_desktop %}, see "[Installing and configuring {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop)" in the {% data variables.product.prodname_desktop %} documentation.
### Sharing feedback
## Sharing feedback
If you have feedback or feature requests, you can open an issue in the [`desktop/desktop` repository](https://github.com/desktop/desktop).

18
content/github/getting-started-with-github/using-github/github-for-mobile.md
View File

@@ -11,7 +11,7 @@ redirect_from:
---
{% data reusables.mobile.ghes-release-phase %}
### About {% data variables.product.prodname_mobile %}
## About {% data variables.product.prodname_mobile %}
{% data reusables.mobile.about-mobile %}
@@ -25,11 +25,11 @@ With {% data variables.product.prodname_mobile %} you can:
For more information about notifications for {% data variables.product.prodname_mobile %}, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#enabling-push-notifications-with-github-for-mobile)."
### Installing {% data variables.product.prodname_mobile %}
## Installing {% data variables.product.prodname_mobile %}
To install {% data variables.product.prodname_mobile %} for Android or iOS, see [{% data variables.product.prodname_mobile %}](https://github.com/mobile).
### Managing accounts
## Managing accounts
You can be simultaneously signed into mobile with one user account on {% data variables.product.prodname_dotcom_the_website %} and one user account on {% data variables.product.prodname_ghe_server %}.
@@ -37,7 +37,7 @@ You can be simultaneously signed into mobile with one user account on {% data va
{% data variables.product.prodname_mobile %} may not work with your enterprise if you're required to access your enterprise over VPN.
#### Prerequisites
### Prerequisites
You must install {% data variables.product.prodname_mobile %} 1.4 or later on your device to use {% data variables.product.prodname_mobile %} with {% data variables.product.prodname_ghe_server %}.
@@ -45,7 +45,7 @@ To use {% data variables.product.prodname_mobile %} with {% data variables.produ
During the beta for {% data variables.product.prodname_mobile %} with {% data variables.product.prodname_ghe_server %}, you must be signed in with a user account on {% data variables.product.prodname_dotcom_the_website %}.
#### Adding, switching, or signing out of accounts
### Adding, switching, or signing out of accounts
You can sign into mobile with a user account on {% data variables.product.product_location %}. At the bottom of the app, long-press {% octicon "person" aria-label="The person icon" %} **Profile**, then tap {% octicon "plus" aria-label="The plus icon" %} **Add Enterprise Account**. Follow the prompts to sign in.
@@ -53,7 +53,7 @@ After you sign into mobile with a user account on {% data variables.product.prod
If you no longer need to access data for your user account on {% data variables.product.product_location %} from {% data variables.product.prodname_mobile %}, you can sign out of the account. At the bottom of the app, long-press {% octicon "person" aria-label="The person icon" %} **Profile**, swipe left on the account to sign out of, then tap **Sign out**.
### Supported languages for {% data variables.product.prodname_mobile %}
## Supported languages for {% data variables.product.prodname_mobile %}
{% data variables.product.prodname_mobile %} is available in the following languages.
@@ -65,7 +65,7 @@ If you no longer need to access data for your user account on {% data variables.
If you configure the language on your device to a supported language, {% data variables.product.prodname_mobile %} will default to the language. You can change the language for {% data variables.product.prodname_mobile %} in {% data variables.product.prodname_mobile %}'s **Settings** menu.
### Managing Universal Links for {% data variables.product.prodname_mobile %} on iOS
## Managing Universal Links for {% data variables.product.prodname_mobile %} on iOS
{% data variables.product.prodname_mobile %} automatically enables Universal Links for iOS. When you tap any {% data variables.product.product_name %} link, the destination URL will open in {% data variables.product.prodname_mobile %} instead of Safari. For more information, see [Universal Links](https://developer.apple.com/ios/universal-links/) on the Apple Developer site.
@@ -73,13 +73,13 @@ To disable Universal Links, long-press any {% data variables.product.product_nam
To re-enable Universal Links, long-press any {% data variables.product.product_name %} link, then tap **Open in {% data variables.product.prodname_dotcom %}**.
### Sharing feedback
## Sharing feedback
If you find a bug in {% data variables.product.prodname_mobile %}, you can email us at <a href="mailto:mobilefeedback@github.com">mobilefeedback@github.com</a>.
You can submit feature requests or other feedback for {% data variables.product.prodname_mobile %} [on GitHub Discussions](https://github.com/github/feedback/discussions?discussions_q=category%3A%22Mobile+Feedback%22).
### Opting out of beta releases for iOS
## Opting out of beta releases for iOS
If you're testing a beta release of {% data variables.product.prodname_mobile %} for iOS using TestFlight, you can leave the beta at any time.

32
content/github/getting-started-with-github/using-github/keyboard-shortcuts.md
View File

@@ -12,13 +12,13 @@ versions:
enterprise-server: '*'
github-ae: '*'
---
### About keyboard shortcuts
## About keyboard shortcuts
Typing <kbd>?</kbd> in {% data variables.product.product_name %} brings up a dialog box that lists the keyboard shortcuts available for that page. You can use these keyboard shortcuts to perform actions across the site without using your mouse to navigate.
Below is a list of some of the available keyboard shortcuts.
### Site wide shortcuts
## Site wide shortcuts
| Keyboard shortcut | Description
|-----------|------------
@@ -26,7 +26,7 @@ Below is a list of some of the available keyboard shortcuts.
|<kbd>g</kbd> <kbd>n</kbd> | Go to your notifications. For more information, see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}"[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[About notifications](/github/receiving-notifications-about-activity-on-github/about-notifications){% endif %}."
|<kbd>esc</kbd> | When focused on a user, issue, or pull request hovercard, closes the hovercard and refocuses on the element the hovercard is in
### Repositories
## Repositories
| Keyboard shortcut | Description
|-----------|------------
@@ -38,7 +38,7 @@ Below is a list of some of the available keyboard shortcuts.
|<kbd>g</kbd> <kbd>w</kbd> | Go to the **Wiki** tab. For more information, see "[About wikis](/communities/documenting-your-project-with-wikis/about-wikis)."{% if currentVersion == "free-pro-team@latest" %}
|<kbd>g</kbd> <kbd>g</kbd> | Go to the **Discussions** tab. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)."{% endif %}
### Source code editing
## Source code editing
| Keyboard shortcut | Description
|-----------|------------
@@ -59,7 +59,7 @@ Below is a list of some of the available keyboard shortcuts.
For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirror.net/doc/manual.html#commands).
### Source code browsing
## Source code browsing
| Keyboard shortcut | Description
|-----------|------------
@@ -71,7 +71,7 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
|<kbd>a</kbd> | Show or hide annotations on diffs
|<kbd>b</kbd> | Open blame view. For more information, see "[Tracing changes in a file](/articles/tracing-changes-in-a-file)."
### Comments
## Comments
| Keyboard shortcut | Description
|-----------|------------
@@ -84,7 +84,7 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
|<kbd>control g</kbd> or <kbd>command g</kbd> | Insert a suggestion. For more information, see "[Reviewing proposed changes in a pull request](/articles/reviewing-proposed-changes-in-a-pull-request)." |{% endif %}
| <kbd>r</kbd> | Quote the selected text in your reply. For more information, see "[Basic writing and formatting syntax](/articles/basic-writing-and-formatting-syntax#quoting-text)." |
### Issue and pull request lists
## Issue and pull request lists
| Keyboard shortcut | Description
|-----------|------------
@@ -97,7 +97,7 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
|<kbd>a</kbd> | Filter by or edit assignee. For more information, see "[Filtering issues and pull requests by assignees](/articles/filtering-issues-and-pull-requests-by-assignees)."
|<kbd>o</kbd> or <kbd>enter</kbd> | Open issue
### Issues and pull requests
## Issues and pull requests
| Keyboard shortcut | Description
|-----------|------------
|<kbd>q</kbd> | Request a reviewer. For more information, see "[Requesting a pull request review](/articles/requesting-a-pull-request-review/)."
@@ -106,7 +106,7 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
|<kbd>a</kbd> | Set an assignee. For more information, see "[Assigning issues and pull requests to other {% data variables.product.company_short %} users](/articles/assigning-issues-and-pull-requests-to-other-github-users/)."
|<kbd>cmd + shift + p</kbd> or <kbd>control + shift + p</kbd> | Toggles between the **Write** and **Preview** tabs
### Changes in pull requests
## Changes in pull requests
| Keyboard shortcut | Description
|-----------|------------
@@ -118,9 +118,9 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
| <kbd>alt</kbd> and click | Toggle between collapsing and expanding all outdated review comments in a pull request by holding down `alt` and clicking **Show outdated** or **Hide outdated**.|{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
| Click, then <kbd>shift</kbd> and click | Comment on multiple lines of a pull request by clicking a line number, holding <kbd>shift</kbd>, then clicking another line number. For more information, see "[Commenting on a pull request](/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)."|{% endif %}
### Project boards
## Project boards
#### Moving a column
### Moving a column
| Keyboard shortcut | Description
|-----------|------------
@@ -132,7 +132,7 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
|<kbd>→</kbd> or <kbd>l</kbd> | Move column to the right
|<kbd>command + →</kbd> or <kbd>command + l</kbd> or <kbd>control + →</kbd> or <kbd>control + l</kbd> | Move column to the rightmost position
#### Moving a card
### Moving a card
| Keyboard shortcut | Description
|-----------|------------
@@ -152,14 +152,14 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
|<kbd>command + →</kbd> or <kbd>command + l</kbd> or <kbd>control + →</kbd> or <kbd>control + l</kbd> | Move card to the bottom of the rightmost column
|<kbd>command + shift + →</kbd> or <kbd>command + shift + l</kbd> or <kbd>control + shift + →</kbd> or <kbd>control + shift + l</kbd> | Move card to the bottom of the rightmost column
#### Previewing a card
### Previewing a card
| Keyboard shortcut | Description
|-----------|------------
|<kbd>esc</kbd> | Close the card preview pane
{% if currentVersion == "free-pro-team@latest" %}
### {% data variables.product.prodname_actions %}
## {% data variables.product.prodname_actions %}
| Keyboard shortcut | Description
|-----------|------------
@@ -171,7 +171,7 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
{% endif %}
### Notifications
## Notifications
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
| Keyboard shortcut | Description
@@ -189,7 +189,7 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
|<kbd>shift + m</kbd> | Mute thread
{% endif %}
### Network graph
## Network graph
| Keyboard shortcut | Description
|-----------|------------

4
content/github/getting-started-with-github/using-github/supported-browsers.md
View File

@@ -11,10 +11,10 @@ versions:
enterprise-server: '*'
github-ae: '*'
---
### Firefox Extended Support Release
## Firefox Extended Support Release
We do our best to support Firefox's latest [Extended Support Release](https://www.mozilla.org/en-US/firefox/organizations/) (ESR). Older versions of Firefox may disable some features on {% data variables.product.product_name %} and require the latest version of Firefox.
### Beta and developer builds
## Beta and developer builds
You may encounter unexpected bugs in beta and developer builds of our supported browsers. If you encounter a bug on {% data variables.product.product_name %} in one of these unreleased builds, please verify that it also exists in the stable version of the same browser. If the bug only exists in the unstable version, consider reporting the bug to the browser developer.

12
content/github/getting-started-with-github/using-github/troubleshooting-connectivity-problems.md
View File

@@ -9,15 +9,15 @@ versions:
---
Most often, connection problems occur because a firewall, proxy server, corporate network, or other network is configured in a way that blocks {% data variables.product.prodname_dotcom %}.
### Allowing {% data variables.product.prodname_dotcom %}'s IP addresses
## Allowing {% data variables.product.prodname_dotcom %}'s IP addresses
Make sure your network is configured to allow {% data variables.product.prodname_dotcom %}'s IP addresses. For more information, see "[About {% data variables.product.prodname_dotcom %}'s IP addresses](/articles/about-github-s-ip-addresses)."
### Using a company or organization's network
## Using a company or organization's network
If you're having connectivity problems on your company or organization's network, check with your network administrator to find out if the network has rules in place to block certain traffic. If there are rules in place, ask your network administrator to allow traffic to {% data variables.product.prodname_dotcom %}.
### Troubleshooting the captcha
## Troubleshooting the captcha
If you're unable to verify with the captcha:
- Ensure JavaScript is enabled on your browser.
@@ -25,18 +25,18 @@ If you're unable to verify with the captcha:
- Ensure your network configuration is not blocking https://octocaptcha.com/ or https://arkoselabs.com/. If you're behind a corporate firewall, contact your IT administrator to allow those domains. To verify access to these domains, visit https://octocaptcha.com/test and ensure the text "Connection successfully made!" is displayed, then visit https://client-demo.arkoselabs.com/github and ensure you are able to load the captcha.
- Ensure your browser does not have plug-ins or extensions that may be interfering with GitHub. If so, temporarily disable the plug-ins or extensions during captcha verification.
### Switching cloning methods
## Switching cloning methods
Switching from cloning via SSH to cloning via HTTPS, or vice versa may improve connectivity. For more information, see "[Cloning a repository from {% data variables.product.prodname_dotcom %}](/articles/cloning-a-repository-from-github)."
If you're encountering timeouts with SSH, see "[Error: Bad file number](/articles/error-bad-file-number)."
### Troubleshooting slow downloads and intermittent slow connections
## Troubleshooting slow downloads and intermittent slow connections
{% data variables.product.prodname_dotcom %} does not throttle bandwidth per user.
If you're experiencing slow connections at certain times of day but not others, the slow speeds are most likely due to network congestion. Because {% data variables.product.prodname_dotcom %} cannot resolve network congestion, you should escalate the problem to your internet service provider.
### Troubleshooting with {% data variables.product.prodname_debug %}
## Troubleshooting with {% data variables.product.prodname_debug %}
If you've followed all of the troubleshooting suggestions above and are still having connection problems, you can follow the instructions on the {% data variables.product.prodname_debug %} site to run tests and send a report to {% data variables.product.prodname_dotcom %} Support. For more information, see [{% data variables.product.prodname_debug %}](https://github-debug.com/).