Descrição geral do guia do contribuidor do Microsoft DocsMicrosoft Docs contributor guide overview

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

Vários dos conjuntos de documentação da Microsoft são open source e estão alojados no GitHub.Several of the Microsoft documentation sets are open source and hosted on GitHub. Nem todos os conjuntos de documentos são completamente open source, mas muitos têm repositórios destinados ao público, onde o utilizador pode fazer alterações sugeridas através de pedidos Pull.Not all document sets are completely open source but many have public-facing repos where you can make suggested changes via pull requests. Esta abordagem open source simplifica e melhora a comunicação entre os engenheiros de produto, as equipas de conteúdo e os clientes e possui outras vantagens:This open source approach streamlines and improves communication between product engineers, content teams, and customers, and has other advantages:

  • Planeamento transparente de repositórios open source para obter feedback sobre quais os documentos mais necessários.Open source repos plan in the open to get feedback on what docs are most needed.
  • Revisão transparente de repositórios open source para publicar os conteúdos mais úteis no nosso primeiro lançamento.Open source repos review in the open to publish the most helpful content on our first release.
  • Atualização transparente de repositórios open source para facilitar as melhorias contínuas dos conteúdos.Open source repos update in the open to make it easier to continuously improve the content.

A experiência de utilizador no docs.microsoft.com integra os fluxos de trabalho do GitHub diretamente para facilitar ainda mais estes processos.The user experience on docs.microsoft.com integrates GitHub workflows directly to make it even easier. Comece por editar o documento que está a ver.Start by editing the document you are viewing. Em alternativa, forneça ajuda ao rever novos tópicos ou criar 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 Microsoft Open Source Code of Conduct (Código de Conduta do Microsoft Open Source) ou o .NET Foundation Code of Conduct (Código de Conduta do .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, veja Code of Conduct FAQ (FAQs do Código de Conduta).For more information, see the Code of Conduct FAQ. Em alternativa, contacte opencode@microsoft.com ou conduct@dotnetfoundation.org relativamente a dúvidas ou comentários.Or contact opencode@microsoft.com, or conduct@dotnetfoundation.org with any questions or comments.

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.Minor corrections or clarifications to documentation and code examples in public repositories are covered by the docs.microsoft.com Terms of Use. As alterações novas ou significativas geram um comentário no pedido Pull que lhe pede para submeter um Contrato de Licença de Contribuição (CLA) caso não seja um colaborador 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 podermos rever ou aceitar o seu pedido Pull, tem de preencher 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 a documentos existentesQuick edits to existing documents

As edições rápidas facilitam o processo de comunicação e correção de pequenos erros e omissões em documentos.Quick edits streamline the process to report and fix small errors and omissions in documents. Apesar de todos os esforços, surgem erros de gramática e ortografia nos nossos documentos publicados.Despite all efforts, small grammar and spelling errors do make their way into our published documents. Embora possa criar problemas para comunicar erros, é mais rápido e fácil criar um pedido Pull (PR) para corrigir o problema, quando a opção está 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-lhe editar conteúdo diretamente no browser.Some docs pages allow you to edit content directly in the browser. Neste caso, verá o botão Edit (Editar) semelhante ao que é apresentado abaixo.If so, you'll see an Edit button like the one shown below. Clicar no botão Edit (ou equivalente na versão localizada) encaminha-o para o ficheiro de origem no GitHub.Clicking the Edit (or equivalently localized) button takes you to the source file on GitHub. Se o botão Edit (ícone de lápis sem texto) não for apresentado, significa que não é possível alterar a página da documentação.If the Edit button (pencil icon without text) is missing, that means the documentation page is not available to be changed.

    Localização da ligação Editar

  2. Em seguida, clique no ícone de lápis para editar o artigo, conforme apresentado.Next, click the pencil icon, to edit the article as shown. Se o ícone de lápis estiver a cinzento, tem de iniciar sessão na sua conta do GitHub ou criar uma nova conta.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 as suas alterações num editor Web.Make your changes in the web editor. Clique no separador Preview changes (Pré-visualizar alterações) para verificar a formatação da alteração.Click the Preview changes tab to check the formatting of your change.

  4. Quando concluir as suas alterações, desloque-se até à parte inferior da página.Once you have made your changes, scroll to the bottom of the page. Introduza um título e uma descrição para as mesmas e clique em Propose file change (Propor alteração ao ficheiro), conforme apresentado na seguinte imagem:Enter a title and description for your changes and click Propose file change as shown in the following figure:

    Propor alteração de ficheiro

  5. Agora que propôs a sua alteração, precisa de pedir aos proprietários do repositório para fazer "pull" das suas alterações para o 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. Esta ação faz-se através daquilo que se chama um "pedido Pull".This is done using something called a "pull request". Quando clicou em Propose file change (Propor alteração ao ficheiro) na figura acima, deveria ter sido encaminhado para uma página nova semelhante à da figura abaixo: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 pedido Pull

    Clique em Create pull request (Criar pedido Pull), introduza um título (e opcionalmente uma descrição) para o pedido Pull e, em seguida, clique em Create pull request de novo.Click Create pull request, enter a title (and optionally a description) for the pull request, and then click Create pull request again. (Se não estiver familiarizado com o GitHub, veja About Pull Requests [Acerca de Pedidos Pull] para obter mais informações.)(If you are new to GitHub, see About Pull Requests for more information.)

  6. Já está!That's it! Os membros da equipa de conteúdos irão rever e intercalar o seu PR.Content team members will review and merge your PR. Caso tenha feito alterações maiores, poderá obter feedback a pedir alterações.You may get some feedback requesting changes if you made larger changes.

A IU 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 válidas para os contribuidores que não têm permissões de escrita para o repositório de destino.The preceding images are accurate for contributors that do not have write permissions to the target repository. O GitHub criará automaticamente um fork do repositório de destino na sua conta.GitHub automatically creates a fork of the target repository in your account. Se tiver acesso de escrita ao repositório de destino, o GitHub criará um novo ramo no repositório de destino.If you have write-access to the target repository, GitHub creates a new branch in the target repo. O nome do ramo terá o formato <GitHubId>-patch-n, com o seu ID do GitHub e um identificador numérico para o ramo de correção.The branch name has the form <GitHubId>-patch-n using your GitHub ID, and a numeric identifier for the patch branch.

Utilizamos pedidos Pull para todas as alterações, mesmo para os contribuidores com acesso de escrita.We use pull requests for all changes, even for contributors that have write-access. A maioria dos repositórios tem o ramo master protegido, pelo que as atualizações têm de ser submetidas como pedidos Pull.Most repositories have the master branch protected so that updates must be submitted as pull requests.

A experiência de edição no browser é recomendada para alterações menores ou pouco frequentes.The in-browser editing experience is best for minor or infrequent changes. 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.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.

Nota

Se estiver ativado, pode editar um artigo em qualquer idioma e, com base no tipo de edição, acontecerá o seguinte:If enabled, you can edit an article in any language and, based on the type of edit, the following will happen:

  1. qualquer alteração linguística que seja aprovada, irá também melhorar o nosso motor de Tradução Automáticaany linguistic change that is approved, will also help improve our Machine Translation engine
  2. qualquer edição que modifique de forma significativa o conteúdo do artigo será gerida internamente para submeter uma alteração ao mesmo artigo em inglês de modo a ser traduzida em todos os idiomas, caso seja 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. As melhorias que sugerir irão afetar de forma positiva não só os artigos no seu idioma, como em todos os idiomas disponíveis.Your suggested improvements will not only positively affect articles in your own language, but in all available languages.

Rever PRs abertosReview open PRs

Pode ler novos tópicos antes de serem publicados ao verificar os PRs abertos 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. Pode ver as atualizações propostas ou novos artigos nos repositórios públicos.You can see proposed updates or new articles in public repositories. Reveja-os e adicione os seus comentários.Review them and add your comments. Veja os nossos repositórios de documentos e verifique os pedidos Pull (PR) abertos nas suas áreas de interesse.Look at any of our docs repositories, and check the open pull requests (PRs) for areas that interest you. O feedback da comunidade sobre as atualizações propostas ajuda toda a comunidade.Community feedback on proposed updates helps the entire community.

Criar problemas de qualidadeCreate quality issues

Os nossos documentos são um trabalho em curso contínuo.Our docs are a continuous work in progress. Os bons problemas ajudam-nos a concentrar os nossos esforços nas principais prioridades da comunidade.Good issues help us focus our efforts on the highest priorities for the community. Quanto mais detalhes fornecer, mais útil será o problema.The more detail you can provide, the more helpful the issue. Diga-nos as informações que procurou.Tell us what information you sought. Diga-nos os termos de pesquisa que utilizou.Tell us the search terms you used. Se não conseguir começar, diga-nos como quer começar a explorar tecnologia com a qual não está familiarizado.If you can't get started, tell us how you want to start exploring unfamiliar technology.

Muitas das páginas de documentação da Microsoft têm uma secção Comentários na parte inferior da página onde pode clicar para enviar Comentários sobre produtos ou Comentários sobre conteúdo para acompanhar problemas específicos desse 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 problemas iniciam a troca de ideias sobre o que é necessário.Issues start the conversation about what's needed. A equipa de conteúdos responderá a estes problemas com ideias sobre o que podemos adicionar e pedirá a sua opinião.The content team will respond to these issues with ideas for what we can add, and ask for your opinions. Quando criarmos um rascunho, pedir-lhe-emos para rever o PR.When we create a draft, we'll ask you to review the PR.

Contribua maisGet more involved

Os outros tópicos ajudam-no a começar a contribuir de forma produtiva para o Microsoft Docs. Explicam como trabalhar com repositórios do GitHub, ferramentas Markdown e extensões utilizadas na plataforma 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.