GitHub Docs
  • All products
  • GitHub
    • User accounts
      • User account settings
        • Your personal dashboard
        • Change your username
        • User into an organization
        • Delete your user account
        • Permission user repositories
        • Permission user project boards
        • Manage access project boards
        • Integrate Jira with projects
      • Manage email preferences
        • Add an email address
        • Primary email address
        • Set backup email address
        • Set commit email address
        • Find your username or email
      • Access to your repositories
        • Invite collaborators
        • Remove a collaborator
        • Remove yourself
      • Manage organization membership
        • Organization membership
        • Accessing an organization
        • View people in an organization
        • Show or hide membership
        • Leave an organization
    • Profiles
      • Customizing your profile
        • About your profile
        • Organization's profile
        • Personalize
        • Pin items
      • Manage contribution graph
        • View contributions
        • Show an overview
        • Private contributions
        • Send your contributions
        • Contributions not on profile
        • Troubleshoot commits
    • Authentication
      • Account security
        • Authentication to GitHub
        • Create a strong password
        • Update access credentials
        • Create a PAT
        • Reviewing your SSH keys
        • Deploy keys
        • Authorizing OAuth Apps
        • Authorizing GitHub Apps
        • Authorized integrations
        • Third-party applications
        • Review OAuth apps
        • Security log
        • Remove sensitive data
        • Sudo mode
        • Unauthorized access
      • Secure your account with 2FA
        • About 2FA
        • Configure 2FA
        • Configure 2FA recovery
        • Access GitHub with 2FA
        • Recover an account with 2FA
        • Disable 2FA
      • Connect with SSH
        • About SSH
        • Check for existing SSH key
        • Generate new SSH key
        • Add a new SSH key
        • Test your SSH connection
        • SSH key passphrases
      • Troubleshooting SSH
        • Recover SSH key passphrase
        • Permission denied (publickey)
        • Error: Bad file number
        • Error: Key already in use
        • Permission denied other-user
        • Permission denied other-repo
        • Agent failure to sign
        • ssh-add: illegal option -- K
        • SSH key audit
      • Verify commit signatures
        • Commit signature verification
        • Existing GPG keys
        • Generating a new GPG key
        • Add a new GPG key
        • Tell Git your signing key
        • Associate email with GPG key
        • Signing commits
        • Signing tags
      • Troubleshoot verification
        • Check verification status
        • Update expired GPG key
        • Use verified email in GPG key
    • Subscriptions & notifications
      • Setting up notifications
        • About notifications
        • Configuring notifications
      • Customize a workflow
        • Manage from your inbox
        • Triage a notification
        • Triage your notifications
      • Manage subscriptions
        • View subscriptions
        • Manage your subscriptions
    • Your enterprise
      • Manage your enterprise
        • About enterprise accounts
      • Manage users
        • Roles in an enterprise
        • Invite people to manage
        • View people in your enterprise
    • Writing on GitHub
      • Start writing on GitHub
        • Write & format on GitHub
        • Basic formatting syntax
      • Work with advanced formatting
        • Organized data with tables
        • Create code blocks
        • Auto linked references
        • Attaching files
        • Permanent links to code
        • Using keywords in issues and pull requests
      • Work with saved replies
        • About saved replies
        • Creating a saved reply
        • Editing a saved reply
        • Deleting a saved reply
        • Using saved replies
      • Share content with gists
        • Creating gists
        • Forking and cloning gists
    • Create, clone & archive
      • Create a repository
        • About repositories
        • Repository visibility
        • Creating a new repository
        • Create from a template
        • About READMEs
        • About code owners
        • Repository languages
        • Licensing a repository
        • Create a template repo
        • Issues-only repository
        • Content & diffs limits
        • Duplicating a repository
      • Clone a repository
        • Cloning a repository
        • HTTPS cloning errors
        • Repository not found
        • Unable to checkout
      • Archive a repository
        • Repositories
        • Archiving repositories
        • Backing up a repository
    • Commit changes to your project
      • Create & edit commits
        • About commits
        • With multiple authors
        • Changing a commit message
      • View & compare commits
        • Branch & tag labels
        • Comparing commits
        • Commit views
      • Troubleshooting commits
        • Commit missing in local clone
        • Linked to wrong user
    • Collaborate with pull requests
      • Getting started
        • Collaborative development
      • Working with forks
        • About forks
        • Configure a remote
        • Syncing a fork
        • Merge an upstream repo
        • Allow changes to a branch
        • Deleted or changes visibility
      • Code quality features
        • About status checks
        • Pre-receive hooks
      • Propose changes
        • About branches
        • Create & delete branches
        • About pull requests
        • Compare branches
        • Creating a pull request
        • Create a PR from a fork
        • Using query parameters to create a pull request
        • Change the state
        • Request a PR review
        • Change the base branch
        • Commit to PR branch from fork
      • Address merge conflicts
        • About merge conflicts
        • Resolve merge conflicts
        • Resolve merge conflicts in Git
      • Review changes
        • About PR reviews
        • Review proposed changes
        • Filter files
        • Methods & functions
        • Comment on a PR
        • View a PR review
        • Incorporate feedback
        • Required reviews
        • Dismiss a PR review
        • Check out a PR locally
      • Incorporate changes
        • About pull request merges
        • Merging a pull request
        • Closing a pull request
        • Reverting a pull request
    • Search on GitHub
      • Start with search on GitHub
        • About searching on GitHub
        • Understand search syntax
        • Troubleshoot search queries
        • Sorting search results
        • Enable search for GitHub.com
      • Searching on GitHub
        • Finding files on GitHub
        • Search for repositories
        • Searching topics
        • Searching code
        • Searching commits
        • Search issues & PRs
        • Searching users
        • Searching wikis
        • Searching in forks
    • Importing your projects
      • Import code to GitHub
        • Import repo locally
        • Add a project locally
        • Code migration tools
      • Work with Subversion on GitHub
        • Subversion & Git differences
        • Support for Subversion clients
        • Properties supported by GitHub
    • Administer a repo
      • Manage repository settings
        • Repository visibility
        • Classify with topics
        • How changed files appear
        • Email notifications for pushes
        • Social media preview
        • View deployment activity
        • Manage the forking policy
        • Disable project boards
        • Disabling issues
        • Anonymous Git read access
        • Configure autolinks
        • Renaming a repository
        • Transferring a repository
        • Deleting a repository
      • Manage branches
        • View branches
        • Change the default branch
        • Delete & restore
      • Configure PR merges
        • Merge methods
        • Configure commit squashing
        • Configure commit rebasing
        • Automatic branch deletion
      • Mergeability of PRs
        • About protected branches
        • Branch protection rule
        • Required status checks
      • Release projects
        • About releases
        • Manage releases
        • View releases & tags
        • Linking to releases
        • Comparing releases
        • Automate release forms
      • Find information in a repo
        • Filter issues & PRs
        • Filter by assignee
        • Filter by labels
        • Filter by review status
        • Sort issues & PRs
        • Use search to filter
        • Sharing filters
    • View repository graphs
      • Access basic repository data
        • About repository graphs
        • View repository activity
        • View project contributors
      • Analyze changes to repository
        • View commits in repository
        • View changes to content
      • Connections between repos
        • View repository network
        • List repository forks
        • Dependency graph
        • Explore dependencies
    • Manage vulnerabilities
      • Manage vulnerable dependencies
        • Dependabot alerts
        • Configuring notifications
    • Manage files in a repository
      • Managing files on GitHub
        • Creating new files
        • Add a file
        • Move a file
        • Edit your files
        • Edit another user's files
        • Track file changes
        • Delete files
        • Renaming a file
        • Permanent links to files
      • Manage files locally
        • Add a file locally
        • Rename a file locally
        • Move a file locally
      • Work with non-code files
        • Render & diff images
        • 3D File Viewer
        • Render CSV & TSV data
        • Rendering PDF documents
        • Differences in prose
        • Mapping geoJSON files
        • Jupyter Notebook files
    • Managing large files
      • Working with large files
        • Large file conditions
        • Remove repository history
        • Distribute large binaries
      • Versioning large files
        • Git Large File Storage
        • Install Git LFS
        • Configure Git LFS
        • Collaboration
        • Move a file to Git LFS
        • Remove files
        • Resolve upload failures
    • Extending GitHub
      • Get started API
      • Automate with OAuth tokens
      • About webhooks
English
  • English
  • 简体中文 (Simplified Chinese)
  • 日本語 (Japanese)
  • Español (Spanish)
  • Português do Brasil (Portuguese)
GitHub Docs

Explore by product

GitHub
Get startedGitHubEnterprise administratorsBilling and paymentsOrganizationsCode securityGitHub IssuesGitHub ActionsGitHub CodespacesGitHub PackagesDevelopersREST APIGraphQL APIGitHub InsightsGitHub DiscussionsGitHub SponsorsBuilding communitiesGitHub PagesEducationGitHub DesktopGitHub CLIAtomElectronCodeQL
English
English简体中文 (Simplified Chinese)日本語 (Japanese)Español (Spanish)Português do Brasil (Portuguese)