Skip to content

Latest commit

 

History

History
241 lines (133 loc) · 18.8 KB

getting-started-with-your-github-account.md

File metadata and controls

241 lines (133 loc) · 18.8 KB
title intro versions
Getting started with your GitHub account
With a personal account on {% data variables.product.prodname_dotcom %}, you can import or create repositories, collaborate with others, and connect with the {% data variables.product.prodname_dotcom %} community.
fpt ghes ghec
*
*
*

This guide will walk you through setting up your {% data variables.product.company_short %} account and getting started with {% data variables.product.product_name %}'s features for collaboration and community.

Part 1: Configuring your {% data variables.product.prodname_dotcom %} account

{% ifversion fpt or ghec %} The first steps in starting with {% data variables.product.product_name %} are to create an account, choose a product that fits your needs best, verify your email, set up two-factor authentication, and view your profile. {% elsif ghes %} The first steps in starting with {% data variables.product.product_name %} are to access your account, set up two-factor authentication, and view your profile. {% endif %}

{% ifversion fpt or ghec %}There are several types of accounts on {% data variables.product.prodname_dotcom %}. {% endif %} Every person who uses {% data variables.product.product_name %} has their own personal account, which can be part of multiple organizations and teams. Your personal account is your identity on {% data variables.location.product_location %} and represents you as an individual.

{% ifversion fpt or ghec %}

1. Creating an account

To sign up for an account, navigate to https://github.com/ and follow the prompts.

To keep your {% data variables.product.prodname_dotcom %} account secure you should use a strong and unique password. For more information, see "AUTOTITLE."

2. Choosing your {% data variables.product.prodname_dotcom %} product

You can choose {% data variables.product.prodname_free_user %} or {% data variables.product.prodname_pro %} to get access to different features for your personal account. You can upgrade at any time if you are unsure at first which product you want.

For more information on all of {% data variables.product.prodname_dotcom %}'s plans, see "AUTOTITLE."

3. Verifying your email address

To ensure you can use all the features in your {% data variables.product.product_name %} plan, verify your email address after signing up for a new account. For more information, see "AUTOTITLE." {% endif %}

{% ifversion ghes %}

1. Accessing your account

{% endif %}

{% ifversion ghes %} The administrator of your {% data variables.product.product_name %} instance will notify you about how to authenticate and access your account. The process varies depending on the authentication mode they have configured for the instance. {% endif %}

{% ifversion fpt or ghec %}4.{% else %}2.{% endif %} Configuring two-factor authentication

Two-factor authentication, or 2FA, is an extra layer of security used when logging into websites or apps. We strongly urge you to configure 2FA for the safety of your account. For more information, see "AUTOTITLE."

{% ifversion passkeys %}Optionally, after you have configured 2FA, add a passkey to your account to enable a secure, passwordless login. See "AUTOTITLE."{% endif %}

{% ifversion fpt or ghec %}5.{% elsif ghes %}3.{% else %}2.{% endif %} Viewing your {% data variables.product.prodname_dotcom %} profile and contribution graph

Your {% data variables.product.prodname_dotcom %} profile tells people the story of your work through the repositories and gists you've pinned, the organization memberships you've chosen to publicize, the contributions you've made, and the projects you've created. For more information, see "AUTOTITLE" and "AUTOTITLE."

Part 2: Using {% data variables.product.product_name %}'s tools and processes

To best use {% data variables.product.product_name %}, you'll need to set up Git. Git is responsible for everything {% data variables.product.prodname_dotcom %}-related that happens locally on your computer. To effectively collaborate on {% data variables.product.product_name %}, you'll write in issues and pull requests using {% data variables.product.prodname_dotcom %} Flavored Markdown.

1. Learning Git

{% data variables.product.prodname_dotcom %}'s collaborative approach to development depends on publishing commits from your local repository to {% data variables.product.product_name %} for other people to view, fetch, and update using Git. For more information about Git, see the "Git Handbook" guide. For more information about how Git is used on {% data variables.product.product_name %}, see "AUTOTITLE."

2. Setting up Git

If you plan to use Git locally on your computer, whether through the command line, an IDE or text editor, you will need to install and set up Git. For more information, see "AUTOTITLE."

If you prefer to use a visual interface, you can download and use {% data variables.product.prodname_desktop %}. {% data variables.product.prodname_desktop %} comes packaged with Git, so there is no need to install Git separately. For more information, see "AUTOTITLE."

Once you install Git, you can connect to {% data variables.product.product_name %} repositories from your local computer, whether your own repository or another user's fork. When you connect to a repository on {% data variables.location.product_location %} from Git, you'll need to authenticate with {% data variables.product.product_name %} using either HTTPS or SSH. For more information, see "AUTOTITLE."

3. Choosing how to interact with {% data variables.product.product_name %}

Everyone has their own unique workflow for interacting with {% data variables.product.prodname_dotcom %}; the interfaces and methods you use depend on your preference and what works best for your needs.

For more information about the different approaches for interacting with {% data variables.product.prodname_dotcom %}, and a comparison of the tools you can use, see "AUTOTITLE."

4. Writing on {% data variables.product.product_name %}

To make your communication clear and organized in issues and pull requests, you can use {% data variables.product.prodname_dotcom %} Flavored Markdown for formatting, which combines an easy-to-read, easy-to-write syntax with some custom functionality. For more information, see "AUTOTITLE."

You can learn {% data variables.product.prodname_dotcom %} Flavored Markdown with the "Communicate using Markdown" course on {% data variables.product.prodname_learning %}.

5. Searching on {% data variables.product.product_name %}

Our integrated search allows you to find what you are looking for among the many repositories, users and lines of code on {% data variables.product.product_name %}. You can search globally across all of {% data variables.product.product_name %} or limit your search to a particular repository or organization. For more information about the types of searches you can do on {% data variables.product.product_name %}, see "AUTOTITLE."

Our search syntax allows you to construct queries using qualifiers to specify what you want to search for. For more information on the search syntax to use in search, see "AUTOTITLE."

6. Managing files on {% data variables.product.product_name %}

With {% data variables.product.product_name %}, you can create, edit, move and delete files in your repository or any repository you have write access to. You can also track the history of changes in a file line by line. For more information, see "AUTOTITLE."

Part 3: Collaborating on {% data variables.product.product_name %}

Any number of people can work together in repositories across {% data variables.product.product_name %}. You can configure settings, create projects, and manage your notifications to encourage effective collaboration.

1. Working with repositories

Creating a repository

A repository is like a folder for your project. You can have any number of public and private repositories in your personal account. Repositories can contain folders and files, images, videos, spreadsheets, and data sets, as well as the revision history for all files in the repository. For more information, see "AUTOTITLE."

When you create a new repository, you should initialize the repository with a README file to let people know about your project. For more information, see "AUTOTITLE."

Cloning a repository

You can clone an existing repository from {% data variables.product.product_name %} to your local computer, making it easier to add or remove files, fix merge conflicts, or make complex commits. Cloning a repository pulls down a full copy of all the repository data that {% data variables.product.prodname_dotcom %} has at that point in time, including all versions of every file and folder for the project. For more information, see "AUTOTITLE."

Forking a repository

A fork is a copy of a repository that you manage, where any changes you make will not affect the original repository unless you submit a pull request to the project owner. 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. For more information, see "AUTOTITLE."

2. Importing your projects

If you have existing projects you'd like to move over to {% data variables.product.product_name %} you can import projects using the {% data variables.product.prodname_importer %}, the command line, or external migration tools. For more information, see "AUTOTITLE."

3. Managing collaborators and permissions

You can collaborate on your project with others using your repository's issues, pull requests, and {% data variables.projects.projects_v2 %}. You can invite other people to your repository as collaborators from the Collaborators tab in the repository settings. For more information, see "AUTOTITLE."

You are the owner of any repository you create in your personal account and have full control of the repository. Collaborators have write access to your repository, limiting what they have permission to do. For more information, see "AUTOTITLE."

4. Managing repository settings

As the owner of a repository you can configure several settings, including the repository's visibility, topics, and social media preview. For more information, see "AUTOTITLE."

5. Setting up your project for healthy contributions

{% ifversion fpt or ghec %} To encourage collaborators in your repository, you need a community that encourages people to use, contribute to, and evangelize your project. For more information, see "Building Welcoming Communities" in the Open Source Guides.

By adding files like contributing guidelines, a code of conduct, and a license to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see "AUTOTITLE." {% endif %} {% ifversion ghes %} By adding files like contributing guidelines, a code of conduct, and support resources to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see "AUTOTITLE." {% endif %}

6. Using {% data variables.product.prodname_github_issues %} and {% data variables.product.prodname_projects_v2 %}

You can use {% data variables.product.prodname_github_issues %} to organize your work with issues and pull requests and manage your workflow with {% data variables.product.prodname_projects_v2 %}. For more information, see "AUTOTITLE" and "AUTOTITLE."

7. Managing notifications

Notifications provide updates about the activity on {% data variables.product.prodname_dotcom %} you've subscribed to or participated in. If you're no longer interested in a conversation, you can unsubscribe, unwatch, or customize the types of notifications you'll receive in the future. For more information, see "AUTOTITLE."

8. Working with {% data variables.product.prodname_pages %}

You can use {% data variables.product.prodname_pages %} to create and host a website directly from a repository on {% data variables.location.product_location %}. For more information, see "AUTOTITLE."

{% ifversion discussions %}

9. Using {% data variables.product.prodname_discussions %}

You can enable {% data variables.product.prodname_discussions %} for your repository to help build a community around your project. Maintainers, contributors and visitors can use discussions to share announcements, ask and answer questions, and participate in conversations around goals. For more information, see "AUTOTITLE." {% endif %}

Part 4: Customizing and automating your work on {% data variables.product.product_name %}

{% data reusables.getting-started.customizing-and-automating %}

{% ifversion fpt or ghec %}

1. Using {% data variables.product.prodname_marketplace %}

{% data reusables.getting-started.marketplace %} {% endif %}

{% ifversion fpt or ghec %}2.{% else %}1.{% endif %} Using the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API

{% data reusables.getting-started.api %}

{% ifversion fpt or ghec %}3.{% else %}2.{% endif %} Building {% data variables.product.prodname_actions %}

{% data reusables.getting-started.actions %}

{% ifversion fpt or ghec %}4.{% else %}3.{% endif %} Publishing and managing {% data variables.product.prodname_registry %}

{% data reusables.getting-started.packages %}

Part 5: Building securely on {% data variables.product.product_name %}

{% data variables.product.product_name %} has a variety of security features that help keep code and secrets secure in repositories. Some features are available for all repositories, while others are only available for public repositories and repositories with a {% data variables.product.prodname_GH_advanced_security %} license. For an overview of {% data variables.product.product_name %} security features, see "AUTOTITLE."

1. Securing your repository

As a repository administrator, you can secure your repositories by configuring repository security settings. These include managing access to your repository, setting a security policy, and managing dependencies. For public repositories, and for private repositories owned by organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled, you can also configure code and secret scanning to automatically identify vulnerabilities and ensure tokens and keys are not exposed.

For more information on steps you can take to secure your repositories, see "AUTOTITLE."

{% ifversion fpt or ghec %}

2. Managing your dependencies

A large part of building securely is maintaining your project's dependencies to ensure that all packages and applications you depend on are updated and secure. You can manage your repository's dependencies on {% data variables.product.product_name %} by exploring the dependency graph for your repository, using Dependabot to automatically raise pull requests to keep your dependencies up-to-date, and receiving Dependabot alerts and security updates for vulnerable dependencies.

For more information, see "AUTOTITLE." {% endif %}

Part 6: Participating in {% data variables.product.prodname_dotcom %}'s community

{% data reusables.getting-started.participating-in-community %}

1. Contributing to open source projects

{% data reusables.getting-started.open-source-projects %}

2. Interacting with {% data variables.product.prodname_gcf %}

{% data reusables.support.ask-and-answer-forum %}

3. Reading about {% data variables.product.product_name %} on {% data variables.product.prodname_docs %}

{% data reusables.docs.you-can-read-docs-for-your-product %}

4. Learning with {% data variables.product.prodname_learning %}

{% data reusables.getting-started.learning %}

{% ifversion fpt or ghec %}

5. Supporting the open source community

{% data reusables.getting-started.sponsors %}

6. Contacting {% data variables.contact.github_support %}

{% data reusables.getting-started.contact-support %}

{% ifversion fpt %}

Further reading