Como trabalhar no GitHub Docs em um codespace

Você pode usar GitHub Codespaces para trabalhar na documentação para GitHub Docs.

Neste artigo

Sobre o GitHub Codespaces

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 Guia Rápido para GitHub Codespaces.

Como trabalhar na documentação em um codespace

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

  1. Navegue até o repositório de código aberto para 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 procedimento por meio do seu fork. Para saber mais, confira Fazer um fork de um repositório.

  3. Crie um ramo para trabalhar. Para saber mais, confira Criar e excluir branches no repositório.

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

    A página "Como configurar seu codespace" será exibida. Após um curto período de Visual Studio Code tempo, a versão baseada em navegador 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/quickstart é o arquivo markdown content/codespaces/quickstart.md.

  6. Edite o arquivo markdown conforme necessário.

  7. Salve suas alterações.

  8. Realize o commit e o push das suas alterações, usando a exibição Controle de Versão ou os comandos 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 solicitação de pull.

  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 não o fizerem, isso pode indicar que há alterações que você não efetuou por push do codespace para GitHub.

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

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

    Sua solicitação de pull será revisada por um membro da GitHub Docs equipe.