Visão geral do guia do colaborador do Microsoft DocsMicrosoft Docs contributor guide overview

Bem-vindo ao Guia do Colaborador do Docs docs.microsoft.com!Welcome to the docs.microsoft.com (Docs) Contributor Guide!

Vários dos conjuntos de documentação da Microsoft são de software livre e estão hospedados no GitHub.Several of the Microsoft documentation sets are open source and hosted on GitHub. Nem todos os conjuntos de documentos são integralmente de software livre, porém muitos têm repositórios públicos, em que é possível sugerir alterações por meio de solicitações de pull.Not all document sets are completely open source but many have public-facing repos where you can make suggested changes via pull requests. Essa abordagem de software livre otimiza e aprimora a comunicação entre os engenheiros de produto, as equipes de conteúdo e os clientes, além de apresentar outras vantagens:This open source approach streamlines and improves communication between product engineers, content teams, and customers, and has other advantages:

  • Os repositórios de software livre contam com planejamento aberto para permitir comentários dos usuários sobre quais documentos são mais necessários.Open source repos plan in the open to get feedback on what docs are most needed.
  • Os repositórios de software livre contam com análise aberta para possibilitar a publicação do conteúdo mais útil logo na primeira versão.Open source repos review in the open to publish the most helpful content on our first release.
  • Os repositórios de software livre contam com atualização aberta para facilitar o aprimoramento contínuo do conteúdo.Open source repos update in the open to make it easier to continuously improve the content.

A experiência do usuário no docs.microsoft.com integra diretamente os fluxos de trabalho do GitHub facilitando ainda mais o processo.The user experience on docs.microsoft.com integrates GitHub workflows directly to make it even easier. Comece editando o documento que você está exibindo.Start by editing the document you are viewing. Ou então, colabore analisando novos tópicos ou criando registros de problemas de qualidade.Or, help by reviewing new topics, or create quality issues.

Importante

Todos os repositórios que publicam no docs.microsoft.com adotaram o Código de Conduta de Software Livre da Microsoft ou o Código de Conduta de .NET Foundation.All repositories that publish to docs.microsoft.com have adopted the Microsoft Open Source Code of Conduct or the .NET Foundation Code of Conduct. Para obter mais informações, consulte Perguntas frequentes sobre código de conduta.For more information, see the Code of Conduct FAQ. Ou entre em contato com opencode@microsoft.com ou conduct@dotnetfoundation.org com perguntas ou comentários.Or contact opencode@microsoft.com, or conduct@dotnetfoundation.org with any questions or comments.

Os Termos de Uso de docs.microsoft.com incluem correções secundárias ou esclarecimentos sobre a documentação, além de exemplos de código nos repositórios públicos.Minor corrections or clarifications to documentation and code examples in public repositories are covered by the docs.microsoft.com Terms of Use. Quando há alterações novas ou significativas, é gerado um comentário na solicitação de pull, pedindo que você envie um CLA (Contrato de Licença de Contribuição) online caso não seja um funcionário da Microsoft.New or significant changes generate a comment in the pull request, asking you to submit an online Contribution License Agreement (CLA) if you are not an employee of Microsoft. Para analisarmos ou aceitarmos sua solicitação de pull, primeiro preencha o formulário online.We need you to complete the online form before we can review or accept your pull request.

Edições rápidas em documentos existentesQuick edits to existing documents

Com as edições rápidas, ficou mais fácil relatar e corrigir pequenos erros e omissões nos documentos.Quick edits streamline the process to report and fix small errors and omissions in documents. Apesar de todos os esforços, pequenos erros gramaticais e ortográficos aparecem em nossos documentos publicados.Despite all efforts, small grammar and spelling errors do make their way into our published documents. Embora você possa criar registros de problemas para relatar erros, é mais fácil e rápido criar uma solicitação de pull para corrigir o problema, quando a opção estiver disponível.While you can create issues to report mistakes, it's faster and easier to create a pull request (PR) to fix the issue, when the option is available.

  1. Algumas páginas de documentos permitem a edição do conteúdo diretamente no navegador.Some docs pages allow you to edit content directly in the browser. Se esse for o caso, você verá o botão Editar, como mostrado abaixo.If so, you'll see an Edit button like the one shown below. Ao clicar no botão Editar (ou em um equivalente), você será levado para o arquivo de origem no GitHub.Clicking the Edit (or equivalently localized) button takes you to the source file on GitHub. Se o botão Editar não aparecer, é porque a página de documentação não aceita alterações.If the Edit button is missing, that means the documentation page is not available to be changed.

    Localização do link de edição

  2. Em seguida, clique no ícone do lápis para editar o artigo conforme mostrado.Next, click the pencil icon, to edit the article as shown. Se o ícone do lápis estiver acinzentado, você precisará fazer logon em sua conta do GitHub ou criar uma.If the pencil icon is grayed out, you need to either log in to your GitHub account or create a new account.

    Localização do ícone de lápis

  3. Faça suas alterações no editor da Web.Make your changes in the web editor. Clique na guia Visualizar alterações para verificar a formatação da alteração.Click the Preview changes tab to check the formatting of your change.

  4. Após ter feito suas alterações, role até a parte inferior da página.Once you have made your changes, scroll to the bottom of the page. Insira um título e uma descrição para suas alterações e clique em Propor alteração de arquivo como mostrado na figura a seguir.Enter a title and description for your changes and click Propose file change as shown in the following figure:

    Propor alteração de arquivo

  5. Agora que você propôs sua alteração, peça aos proprietários do repositório para "efetuar pull" de suas alterações no repositório.Now that you've proposed your change, you need to ask the owners of the repository to "pull" your changes into their repository. Isso é feito com o que denominamos como "solicitação de pull".This is done using something called a "pull request". Quando você clicou em Propor alteração do arquivo na figura acima, provavelmente foi direcionado para uma nova página, semelhante a esta:When you clicked on Propose file change in the figure above, you should have been taken to a new page that looks like the following figure:

    criar solicitação de pull

    Clique em Criar solicitação de pull, insira um título (e, se desejar, uma descrição) para a solicitação de pull e clique novamente em Criar solicitação de pull.Click Create pull request, enter a title (and optionally a description) for the pull request, and then click Create pull request again. (Se você for novo no GitHub, confira About Pull Requests (Sobre solicitações de pull) para saber mais.)(If you are new to GitHub, see About Pull Requests for more information.)

  6. Pronto!That's it! Membros da equipe de conteúdo analisarão e mesclarão sua solicitação de pull.Content team members will review and merge your PR. Você pode receber comentários solicitando alterações caso tenha feito mudanças mais significativas.You may get some feedback requesting changes if you made larger changes.

A interface do usuário de edição do GitHub responde às suas permissões no repositório.The GitHub editing UI responds to your permissions on the repository. As imagens anteriores são exibidas com precisão para os colaboradores que não têm permissões de gravação no repositório de destino.The preceding images are accurate for contributors that do not have write permissions to the target repository. O GitHub cria automaticamente um fork para o repositório de destino em sua conta.GitHub automatically creates a fork of the target repository in your account. Se você tem acesso de gravação para o repositório de destino, o GitHub cria nele um novo branch.If you have write-access to the target repository, GitHub creates a new branch in the target repo. O nome do branch tem o formato <GitHubId>-patch-n, que usa a ID do GitHub e um identificador numérico para o branch do patch.The branch name has the form <GitHubId>-patch-n using your GitHub ID, and a numeric identifier for the patch branch.

Usamos solicitações de pull para todas as alterações, mesmo para colaboradores que têm acesso de gravação.We use pull requests for all changes, even for contributors that have write-access. A maioria dos repositórios tem o branch master protegido, de modo que as atualizações precisam ser enviadas como solicitações de pull.Most repositories have the master branch protected so that updates must be submitted as pull requests.

A experiência de edição no navegador é a melhor para alterações secundárias ou esporádicas.The in-browser editing experience is best for minor or infrequent changes. Se fizer grandes colaborações ou usar recursos avançados do Git (como gerenciamento de branch ou resolução avançada de conflitos de mesclagem), você precisará criar um fork do repositório e trabalhar localmente.If you make large contributions or use advanced Git features (such as branch management or advanced merge conflict resolution), you need to fork the repo and work locally.

Observação

Se o recurso de edições rápidas estiver habilitado, você poderá editar um artigo em qualquer idioma. Com base no tipo de edição, ocorrerá o seguinte:If enabled, you can edit an article in any language and, based on the type of edit, the following will happen:

  1. Todas as alterações linguísticas aprovadas também ajudarão a aprimorar nosso mecanismo de tradução automática.any linguistic change that is approved, will also help improve our Machine Translation engine
  2. Qualquer edição que modifique significativamente o conteúdo do artigo será tratada internamente para que a alteração seja aplicada ao mesmo artigo em inglês, a fim de que seja localizada em todos os idiomas, se aprovada.any edit that significantly modifies the content of the article will be handled internally to submit a change to the same article in English so that it will get localized in all languages if approved. Os aprimoramentos que você sugerir terão um efeito positivo nos artigos não só no seu próprio idioma, mas em todos os idiomas disponíveis.Your suggested improvements will not only positively affect articles in your own language, but in all available languages.

Examinar as solicitações de pull em abertoReview open PRs

Você pode ler novos tópicos antes de eles serem publicados, verificando as solicitações de pull em aberto atualmente.You can read new topics before they are published by checking the currently open PRs. As revisões seguem o processo do fluxo do GitHub.Reviews follow the GitHub flow process. Você pode ver as atualizações propostas ou novos artigos em repositórios públicos.You can see proposed updates or new articles in public repositories. Revise-os e adicione seus comentários.Review them and add your comments. Confira um dos nossos repositórios de documentos e verifique as PRs (solicitações de pull) em aberto para áreas do seu interesse.Look at any of our docs repositories, and check the open pull requests (PRs) for areas that interest you. Os comentários da comunidade sobre atualizações propostas ajudam toda a comunidade.Community feedback on proposed updates helps the entire community.

Criar registros de problemas de qualidadeCreate quality issues

Nossos documentos estão sempre em evolução.Our docs are a continuous work in progress. E, com bons registros de problemas, conseguimos concentrar nossos esforços no que é mais importante para a comunidade.Good issues help us focus our efforts on the highest priorities for the community. Quanto mais detalhes você fornecer, mais útil será o registro do problema.The more detail you can provide, the more helpful the issue. Diga-nos quais informações você buscou.Tell us what information you sought. Diga-nos quais termos de pesquisa você usou.Tell us the search terms you used. Se você não souber como começar, diga-nos como deseja explorar novas tecnologias.If you can't get started, tell us how you want to start exploring unfamiliar technology.

Muitas páginas da documentação da Microsoft têm uma seção de Comentários na parte inferior onde você pode clicar para enviar comentários sobre o produto ou comentários sobre o conteúdo e, assim, rastrear problemas específicos daquele artigo.Many of Microsoft's documentation pages have a Feedback section at the bottom of the page where you can click to leave Product feedback or Content feedback to track issues that are specific to that article.

Os registros de problemas é o pontapé inicial.Issues start the conversation about what's needed. A equipe de conteúdo responderá a esses registros de problemas com ideias sobre o que podemos adicionar e pedirá suas opiniões.The content team will respond to these issues with ideas for what we can add, and ask for your opinions. Quando criarmos um rascunho, pediremos a você que revise a solicitação de pull.When we create a draft, we'll ask you to review the PR.

Aumente seu engajamentoGet more involved

Outros tópicos ajudam você a começar a contribuir de modo produtivo com o Microsoft Docs. Eles explicam o trabalho com repositórios do GitHub, ferramentas de Markdown e extensões usadas na plataforma do Microsoft Docs.Other topics help you get started productively contributing to Microsoft Docs. They explain working with GitHub repositories, Markdown tools, and extensions used in the Microsoft Docs platform.