Sobre a contribuição com o GitHub Docs

A documentação do GitHub tem o código aberto. Qualquer pessoa pode contribuir com a documentação no repositório público docs: https://github.com/github/docs. Os funcionários do GitHub trabalham na documentação em uma cópia desse repositório chamada docs-internal. Os dois repositórios são sincronizados automaticamente para mantê-los atualizados com as alterações mescladas no branch main de qualquer repositório. Para simplificar, vamos nos referir ao "repositório da documentação" nos artigos sobre como contribuir com o GitHub Docs.

O repositório da documentação é o local para discutir e colaborar na documentação publicada aqui no docs.github.com.

Problemas

Os problemas são usados para acompanhar tarefas com as quais os colaboradores podem ajudar. Se um problema tiver um rótulo triage, ainda não o revisamos e você não deve começar a trabalhar nele.

Se você encontrou algo no conteúdo da documentação ou algo sobre o site docs.github.com que deve ser atualizado, pesquise os problemas em aberto para ver se outra pessoa relatou a mesma coisa. Se isso for algo novo, abra um problema usando um modelo. Usaremos o problema para ter uma conversa sobre o problema para o qual você deseja uma correção.

Solicitações de pull

Uma pull request é uma forma de sugerir alterações em nosso repositório. Quando mesclamos essas alterações, elas são implantadas no site online em até 24 horas.

Não podemos aceitar contribuições à documentação de referência da API REST. Se você detectar uma imprecisão na documentação de referência da API REST, abra um problema no repositório rest-api-description.

Documentamos apenas produtos, recursos, ferramentas e extensões do GitHub. Podemos mencionar ou vincular a ferramentas de terceiros para demonstrar como um recurso funciona, mas não aceitamos pull requests para documentar ferramentas ou integrações de terceiros, a menos que tenham sido desenvolvidas em conjunto com a GitHub.

Como revisar suas pull requests

Você sempre deve revisar sua pull request primeiro antes de marcá-la como pronta para revisão por outras pessoas.

Para as alterações de conteúdo, lembre-se de:

• Confirmar se as alterações atendem à experiência do usuário e às metas descritas no plano de design de conteúdo (se houver).
• Revisar o conteúdo quanto à precisão técnica.
• Verificar a gramática, a ortografia e a conformidade com o Guia de estilo.
• Verificar se o texto da pull request será fácil de ser traduzido. Para obter mais informações, confira "Como escrever um conteúdo para tradução".
• Verificar as instruções novas ou atualizadas do Liquid para confirmar se o controle de versão está correto. Para obter mais informações, confira "Documentação de controle de versão".
• Verificar a visualização de todas as páginas que você alterou. Uma visualização é gerada automaticamente depois que você envia uma pull request e os links são adicionados à pull request. Às vezes, a visualização leva vários minutos antes de estar pronta para ser visualizada. Confirmar se tudo está sendo renderizado conforme o esperado. A verificação da visualização ajudará você a identificar problemas como erros de digitação, um conteúdo que não segue o guia de estilo ou um conteúdo que não está sendo renderizado devido a problemas de controle de versão. Lembre-se de verificar as listas e as tabelas na saída renderizada, que às vezes podem ter problemas difíceis de serem identificados no Markdown.
• Se houver verificações com falha na pull request, solucione-as até que todas elas sejam aprovadas.

Suporte

Somos uma pequena equipe trabalhando duro para acompanhar as demandas da documentação de um produto em constante mudança. Infelizmente, não podemos ajudar a responder perguntas sobre suporte neste repositório. Se você estiver tendo um problema com o GitHub, não relacionado à nossa documentação, entre em contato diretamente com o Suporte do GitHub. Qualquer problema ou pull request aberto no repositório da documentação solicitando suporte receberá informações sobre como entrar em contato com o Suporte do GitHub e, em seguida, será fechado e bloqueado.

Se você estiver tendo problemas com sua conta do GitHub, entre em contato com o Suporte.

Translations

Este site está internacionalizado e disponível em vários idiomas. O conteúdo de origem deste repositório foi escrito em inglês. Automatizamos as traduções por meio de um processo interno, trabalhando com tradutores profissionais para localizar o conteúdo em inglês.

Caso você detecte um erro de tradução, gere um problema com os detalhes.

No momento, não aceitamos pull requests para o conteúdo traduzido.

Política do Site

As políticas do site GitHub também são publicadas em docs.github.com.

Caso você encontre um erro de digitação na seção de política do site, abra uma pull request para corrigi-lo. Para outros tópicos, confira "Contribuições" no repositório site-policy.