Create a repo

To put your project up on GitHub, you'll need to create a repository for it to live in.

Create a repository

You can store a variety of projects in GitHub repositories, including open source projects. With open source projects, you can share code to make better, more reliable software. You can use repositories to collaborate with others and track your work. For more information, see "About repositories."

Note: You can create public repositories for an open source project. When creating your public repository, make sure to include a license file that determines how you want your project to be shared with others. Para mais informações sobre código aberto, especificamente como criar e crescer um projeto de código aberto, Criamos Guias em Código Aberto que ajudarão você a fomentar uma comunidade de código aberto saudável, recomendando as melhores práticas para a criação e manutenção de repositórios para seu projeto de código aberto. Você também pode participar de um curso gratuito GitHub Learning Lab sobre a manutenção de comunidades de código aberto.

  1. No canto superior direito de qualquer página, use o menu suspenso e selecione Novo repositório. Menu suspenso com a opção de criar um novo repositório
  2. Type a short, memorable name for your repository. For example, "hello-world". Field for entering a repository name
  3. Optionally, add a description of your repository. For example, "My first repository on GitHub." Field for entering a repository description
  4. Escolha uma visibilidade do repositório. Para obter mais informações, consulte "Sobre repositórios". Botões de opção para selecionar a visibilidade do repositório
  5. Selecione Initialize this repository with a README (Inicializar este repositório com um README). Caixa de seleção Initialize this repository with a README (Inicializar este repositório com um README)
  6. Clique em Create Repository (Criar repositório). Button to create repository

Congratulations! You've successfully created your first repository, and initialized it with a README file.

Para saber mais sobre GitHub CLI, consulte "Sobre GitHub CLI."

  1. In the command line, navigate to the directory where you would like to create a local clone of your new project.
  2. To create a repository for your project, use the gh repo create subcommand. When prompted, select Create a new repository on GitHub from scratch and enter the name of your new project. If you want your project to belong to an organization instead of to your user account, specify the organization name and project name with organization-name/project-name.
  3. Follow the interactive prompts. To clone the repository locally, confirm yes when asked if you would like to clone the remote project directory.
  4. Alternatively, to skip the prompts supply the repository name and a visibility flag (--public, --private, or --internal). For example, gh repo create project-name --public. To clone the repository locally, pass the --clone flag. For more information about possible arguments, see the GitHub CLI manual.

Commit your first change

A commit is like a snapshot of all the files in your project at a particular point in time.

When you created your new repository, you initialized it with a README file. README files are a great place to describe your project in more detail, or add some documentation such as how to install or use your project. The contents of your README file are automatically shown on the front page of your repository.

Let's commit a change to the README file.

  1. In your repository's list of files, click README.md. README file in file list
  2. Above the file's content, click .
  3. On the Edit file tab, type some information about yourself. New content in file
  4. Acima do novo conteúdo, clique em Preview changes (Visualizar alterações). Botão de visualização do arquivo
  5. Review the changes you made to the file. You'll see the new content in green. File preview view
  6. No final da página, digite uma mensagem de commit curta e significativa que descreva a alteração feita no arquivo. Você pode atribuir o commit a mais de um autor na mensagem de commit. Para obter mais informações, consulte "Criar um commit com vários co-autores." Mensagem do commit para sua alteração
  7. Abaixo dos campos de mensagem do commit, opte por adicionar o commit ao branch atual ou a um novo branch. Se seu branch atual for o branch-padrão, você deverá optar por criar um novo branch para seu commit e, em seguida, criar um pull request. Para obter mais informações, consulte "Criar uma nova pull request." Opções para fazer commit no branch
  8. Clique em Propose file change (Propor alteração no arquivo). Botão Propose changes (Propor alterações)

Now that you have created a project, you can start committing changes.

README files are a great place to describe your project in more detail, or add some documentation such as how to install or use your project. The contents of your README file are automatically shown on the front page of your repository. Follow these steps to add a README file.

  1. In the command line, navigate to the root directory of your new project. (This directory was created when you ran the gh repo create command.)

  2. Create a README file with some information about the project.

    echo "info about this project" >> README.md
  3. Enter git status. You will see that you have an untracked README.md file.

    $ git status
    
    Untracked files:
      (use "git add ..." to include in what will be committed)
      README.md
    
    nothing added to commit but untracked files present (use "git add" to track)
  4. Stage and commit the file.

    git add README.md && git commit -m "Add README"
  5. Push the changes to your branch.

    git push --set-upstream origin HEAD

Celebrate

Congratulations! You have now created a repository, including a README file, and created your first commit on GitHub.com.

You can now clone a GitHub repository to create a local copy on your computer. From your local repository you can commit, and create a pull request to update the changes in the upstream repository. For more information, see "Cloning a repository" and "Set up Git."

You can find interesting projects and repositories on GitHub and make changes to them by creating a fork of the repository. For more information see, "Fork a repository."

Each repository in GitHub is owned by a person or an organization. You can interact with the people, repositories, and organizations by connecting and following them on GitHub. For more information see "Be social."

GitHub tem uma ótima comunidade de suporte onde você pode pedir ajuda e conversar com pessoas de todo o mundo. Junte-se à conversa na Comunidade de Suporte do Github.

Esse documento ajudou você?

Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.