Descrição geral do guia do contribuidor do Microsoft Docs

Bem-vindo ao guia de contribuidores Microsoft Docs!

Vários dos conjuntos de documentação da Microsoft são open source e estão alojados no GitHub. Nem todos os conjuntos de documentos são completamente open source, mas muitos têm repos virados para o público onde você pode sugerir alterações através de pedidos de pull (PR). Esta abordagem de código aberto simplifica e melhora a comunicação entre engenheiros de produtos, equipas de conteúdos e clientes, e tem outras vantagens:

  • Plano de repouso de código aberto em aberto para obter feedback sobre o que os médicos são mais necessários.
  • Open-source repos review in the open to publish the most helpful content on our first release.
  • A atualização de repos de código aberto no open para facilitar a melhoria contínua do conteúdo.

A experiência do utilizador em Microsoft Docs integra os fluxos de trabalho do GitHub diretamente para torná-lo ainda mais fácil. Comece por editar o documento que está a ver. Ou ajudar , analisando novos tópicos ou criando problemas de qualidade.

Importante

Todos os repositórios que publicam para Microsoft Docs adotaram o Código de Conduta da Microsoft Open Source ou o Código de Conduta da Fundação .NET. Para obter mais informações, veja Code of Conduct FAQ (FAQs do Código de Conduta). Contacto opencode@microsoft.com ou conduct@dotnetfoundation.org com quaisquer perguntas ou comentários.

As pequenas correções ou esclarecimentos à documentação e exemplos de código em repositórios públicos estão abrangidos nos Termos de Utilização do docs.microsoft.com. Alterações novas ou significativas geram um comentário no PR, pedindo-lhe para submeter um Contrato de Licença de Contribuição On-line (CLA) se não for um funcionário da Microsoft. Precisamos que preencha o formulário online antes de podermos rever ou aceitar o seu Pr.

Edições rápidas para documentação

As edições rápidas simplificam o processo para relatar e corrigir pequenos erros e omissões na documentação. Apesar de todos os esforços, surgem erros de gramática e ortografia nos nossos documentos publicados. Embora possa criar problemas para relatar erros, é mais rápido e fácil criar um Pr para corrigir o problema, quando a opção está disponível.

  1. Algumas páginas de documentos permitem-lhe editar conteúdo diretamente no browser. Neste caso, verá o botão Edit (Editar) semelhante ao que é apresentado abaixo. A escolha do botão Edit (ou mente localizada) leva-o ao ficheiro de origem do GitHub.

    Localização do link de artigo de edição.

    Se o botão Editar não estiver presente, significa que o conteúdo não está aberto a contribuições públicas. Algumas páginas são geradas (por exemplo, a partir de documentação inline em código) e devem ser editadas no projeto a que pertencem.

  2. Selecione o ícone do lápis para editar o artigo. Se o ícone de lápis estiver a cinzento, tem de iniciar sessão na sua conta do GitHub ou criar uma nova conta.

    Localização do garfo e ícone de lápis de edição.

  3. Edite o ficheiro no editor da web. Escolha o separador Pré-visualização para verificar a formatação das suas alterações.

  4. Quando terminar de editar, percorra para a parte inferior da página. Na área de alterações propostas , insira um título e opcionalmente uma descrição para as suas alterações. O título será a primeira linha da mensagem de compromisso. Selecione Proposta alterações para cometer as suas alterações:

    Propor e comprometer alterações de ficheiros.

  5. Agora que propôs e cometeu as suas alterações, precisa de pedir aos proprietários do repositório que "puxem" as suas mudanças para o seu repositório. Isto é feito usando algo chamado "pull request" (PR). Quando seleciona Propose alterações, é apresentada uma nova página semelhante à seguinte:

    Compare as alterações e crie um pedido de puxar.

    Selecione Criar pedido de puxar. Em seguida, insira um título e uma descrição para o PR e, em seguida, selecione Create pull request. Se é novo no GitHub, consulte Sobre os pedidos de mais informações.

  6. Já está! Os membros da equipa de conteúdo irão rever o seu Pr e fundi-lo quando for aprovado. Pode obter alterações no pedido de comentários.

A IU de edição do GitHub responde às suas permissões no repositório. As imagens anteriores são para os contribuintes que não têm permissões de escrita para o repositório alvo. O GitHub criará automaticamente um fork do repositório de destino na sua conta. O nome do garfo recém-criado tem o formulário GitHubUsername/RepositoryName por defeito. Se tiver acesso ao repositório alvo, como o seu garfo, o GitHub cria um novo ramo no repositório alvo. O nome do ramo tem o patch den formulário predefinido, utilizando um identificador numérico para o ramo de remendo.

Utilizamos PRs para todas as alterações, mesmo para os contribuintes que têm acesso por escrito. A maioria dos repositórios protege o ramo predefinido para que as atualizações sejam submetidas como PRs.

A experiência de edição no browser é recomendada para alterações menores ou pouco frequentes. Se fizer contribuições maiores ou utilizar funcionalidades avançadas do Git (como a gestão de ramificações ou resolução de conflitos de intercalação avançada), tem de criar um fork do repositório e trabalhar localmente.

Nota

A maioria da documentação localizada não oferece a capacidade de editar ou fornecer feedback através do GitHub. Para fornecer feedback sobre conteúdo localizado, use o modelo de e-mail disponível em aka.ms/DocSiteLocFeedback.

Rever PRs abertos

Pode ler novos tópicos antes de serem publicados, verificando a fila de relações públicas aberta. As revisões seguem o processo do fluxo do GitHub. Pode ver as atualizações propostas ou novos artigos nos repositórios públicos. Reveja-os e adicione os seus comentários. Olhe para qualquer um dos nossos repositórios docs, e verifique os PRs abertos para áreas que lhe interessam. O feedback da comunidade sobre as atualizações propostas ajuda toda a comunidade.

Criar problemas de qualidade

Os nossos documentos são um trabalho em curso contínuo. Os bons problemas ajudam-nos a concentrar os nossos esforços nas principais prioridades da comunidade. Quanto mais detalhes fornecer, mais útil será o problema. Diga-nos as informações que procurou. Diga-nos os termos de pesquisa que utilizou. Se não conseguir começar, diga-nos como quer começar a explorar tecnologia com a qual não está familiarizado.

Muitas das páginas de documentação da Microsoft têm uma secção de Feedback na parte inferior da página onde pode optar por deixar o feedback do Produto ou feedback do Conteúdo para rastrear problemas específicos desse artigo.

Os problemas iniciam a troca de ideias sobre o que é necessário. A equipa de conteúdos responderá a estes problemas com ideias sobre o que podemos adicionar e pedirá a sua opinião. Quando criarmos um rascunho, pedir-lhe-emos para rever o PR.

Contribua mais

Outros tópicos neste guia ajudam-no a começar a contribuir produtivamente para Microsoft Docs. Explicam trabalhar com repositórios do GitHub, ferramentas markdown e extensões usadas na plataforma Microsoft Docs.