Como trabalhar no GitHub Docs em um codespace

Use o GitHub Codespaces para trabalhar na documentação do GitHub Docs.

Neste artigo

Sobre os GitHub Codespaces

O GitHub Codespaces permite que você trabalhe em um ambiente de desenvolvimento hospedado remotamente do computador. Você pode começar rapidamente, sem precisar configurar o ambiente de trabalho ou baixar arquivos no computador local.

Para saber mais, confira Visão geral do GitHub Codespaces.

Como trabalhar na documentação em um codespace

As etapas a seguir pressupõem que você tenha o GitHub Codespaces configurado para editar arquivos usando o Visual Studio Code para Web. As etapas serão muito semelhantes se você tiver definido um editor diferente. Para saber mais, confira Como definir seu editor padrão para o GitHub Codespaces.

  1. Navegue até o repositório de código aberto do GitHub Docs, github/docs.

  2. Se você for um colaborador de código aberto, crie um fork do repositório e siga o restante das etapas neste procedimentos por meio do fork. Para saber mais, confira Criar fork de um repositório.

  3. Crie um branch de trabalho. Para saber mais, confira Criar e excluir branches no repositório.

  4. Na página principal do repositório, clique em Código e clique em Criar codespace no NOME-DO-BRANCH.

    A página "Como configurar seu codespace" será exibida. Após um curto período, a versão baseada em navegador do Visual Studio Code será exibida.

  5. Use o Explorer para navegar até o arquivo markdown que deseja editar. Se o arquivo for um artigo, ele estará localizado no diretório content. Se o arquivo for um conteúdo reutilizável, ele estará localizado no diretório data.

    Na maioria dos casos, o caminho para um artigo no diretório content corresponde ao caminho na URL, menos a extensão de arquivo .md. Por exemplo, a origem do artigo https://docs.github.com/en/codespaces/getting-started/quickstart é o arquivo markdown content/codespaces/getting-started/quickstart.md.

  6. Edite o arquivo markdown conforme necessário.

  7. Salve suas alterações.

  8. Faça commit e efetue push das alterações usando a exibição Controle do Código-fonte ou os comandos do Git no Terminal. Para saber mais, confira Sobre o Git.

Como criar uma solicitação de pull

  1. Navegue até a guia "Pull requests" do repositório github/docs em github.com/github/docs/pulls.

  2. Clique em Nova pull request.

  3. Se você for um colaborador de código aberto, clique em comparação entre forks e escolha o repositório com fork criado e o branch de trabalho.

    Caso contrário, altere o branch "compare" para o branch de trabalho.

  4. Verifique se as alterações exibidas incluem todas as alterações feitas no codespace. Se elas não as incluírem, isso poderá indicar que há alterações das quais você não efetuou push do codespace para o GitHub.

  5. Clique em Criar solicitação de pull.

  6. Insira os detalhes da pull request e clique em Criar pull request.

    A pull request será revisada por um membro da equipe do GitHub Docs.