GitHub Docs
  • All products
  • GitHub
    • User accounts
      • User account settings
        • Your personal dashboard
        • Manage theme settings
        • Change your username
        • Merge multiple user accounts
        • User into an organization
        • Delete your user account
        • Permission user repositories
        • Permission user project boards
        • Manage default branch name
        • Manage security & analysis
        • Manage access project boards
        • Leaving your company
        • Available for hire checkbox
      • Manage email preferences
        • Add an email address
        • Primary email address
        • Set backup email address
        • Set commit email address
        • Block push with personal email
        • Find your username or email
        • Emails from GitHub
        • Marketing emails
      • Access to your repositories
        • Invite collaborators
        • Remove a collaborator
        • Remove yourself
        • Ownership continuity
      • Manage organization membership
        • Organization membership
        • Accessing an organization
        • View people in an organization
        • Request OAuth App approval
        • Show or hide membership
        • Manage scheduled reminders
        • Leave an organization
    • Profiles
      • Customizing your profile
        • About your profile
        • Organization's profile
        • Personalize
        • Your profile README
        • 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
        • About anonymized URLs
        • GitHub's IP addresses
        • SSH key fingerprints
        • 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
        • Change 2FA delivery method
        • Countries supporting SMS
        • Disable 2FA
      • Authenticate with SAML
        • SAML single sign-on
        • SSH Key with SAML
        • PAT with SAML
        • Active SAML sessions
      • 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
        • Use SSH over HTTPS port
        • Recover SSH key passphrase
        • Deleted or missing SSH keys
        • 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
        • SSL certificate problem
        • Error: Unknown key type
        • SSH key audit
      • Verify commit signatures
        • Commit signature verification
        • Displaying verification for all commits
        • 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
    • GitHub Copilot
      • About GitHub Copilot telemetry
      • Telemetry terms
      • Research recitation
    • 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
        • Verify or approve a domain
        • View subscription & usage
        • Visual Studio bundle
        • Connect an Azure subscription
      • Manage users
        • Roles in an enterprise
        • Invite people to manage
        • Manage support entitlements
        • View people in your enterprise
        • View & manage SAML access
      • Manage organizations
        • Add organizations
        • Manage unowned organizations
        • View organization audit logs
        • Configure webhooks
      • Configure IAM
        • IAM for your enterprise
        • Enforce SSO for organizations
        • Configure SAML SSO
        • Manage team synchronization
      • Set organization policies
        • Policies for repositories
        • Policies for projects
        • Enforce team policies
        • Enforce security settings
        • Restrict email notifications
        • Policy for dependency insights
        • Policies for GitHub Actions
        • Configure Actions retention
        • Policies for Advanced Security
    • 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
        • About CITATION files
        • 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
        • Archive content & data
        • Reference & cite content
        • Backing up a repository
    • Commit changes to your project
      • Create & edit commits
        • About commits
        • With multiple authors
        • On behalf of an organization
        • 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 PRs
      • 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
      • 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
        • Review dependency changes
        • Incorporate feedback
        • Required reviews
        • Dismiss a PR review
        • Check out a PR locally
      • Incorporate changes
        • About pull request merges
        • Merging a pull request
        • Merge PR automatically
        • 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 discussions
        • Search GitHub Marketplace
        • Searching users
        • Searching for packages
        • Searching wikis
        • Searching in forks
    • Importing your projects
      • Import code to GitHub
        • About GitHub Importer
        • Use GitHub Importer
        • Update author GitHub Importer
        • 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
        • Teams & people
        • Classify with topics
        • How changed files appear
        • Email notifications for pushes
        • Display a sponsor button
        • Social media preview
        • View deployment activity
        • Manage the forking policy
        • Set log retention for Actions
        • GitHub Actions
        • Discussions
        • Disable project boards
        • Disabling issues
        • Managing Git LFS objects in archives
        • Security & analysis
        • Configure autolinks
        • Renaming a repository
        • Transferring a repository
        • Deleting a repository
        • Restore deleted repository
      • Manage branches
        • View branches