Ler em inglês

Compartilhar via


Contribuir para esta documentação

Agradecemos seu interesse em nossa documentação!

Contribuir usando o GitHub

Use o GitHub para contribuir com essa documentação sem precisar clonar o repositório para sua área de trabalho. Essa é a maneira mais fácil de criar uma solicitação de pull neste repositório. Use esse método para fazer uma pequena alteração que não envolva alterações de código. O uso desse método permite que você contribua para um artigo por vez.

Para contribuir usando o GitHub

  1. Localize o artigo para o qual você deseja contribuir no GitHub.
  2. Depois de entrar no artigo no GitHub, entre no GitHub (obtenha uma conta gratuita Ingresse no GitHub).
  3. Escolha o ícone de lápis (edite o arquivo na bifurcação deste projeto) e faça suas alterações na <>janela Editar arquivo .
  4. Role até a parte inferior e insira uma descrição.
  5. Escolha Propor alteração de arquivo Criar solicitação>de pull.

Agora você enviou com êxito uma solicitação de pull. As solicitações de pull normalmente são revisadas dentro de 10 dias úteis.

Contribuir usando o Git

Use o Git para contribuir com alterações substantivas, como:

  • Código de contribuição.
  • Contribuindo com alterações que afetam o significado.
  • Contribuindo com grandes alterações no texto.
  • Adicionando novos tópicos.

Para contribuir usando o Git

  1. Se você não tiver uma conta do GitHub, configure uma no GitHub.

  2. Depois de ter uma conta, instale o Git no computador. Siga as etapas no tutorial [Configurar Git].

  3. Para enviar uma solicitação de pull usando o Git, siga as etapas em Usar GitHub, Git e este repositório.

  4. Você será solicitado a assinar o Contrato de Licença do Colaborador se for:

    • Membro do grupo Microsoft Open Technologies.
    • Um contribuidor que não trabalha para a Microsoft.

Como membro da comunidade, você deve assinar o CLA (Contrato de Licença de Contribuição) para poder contribuir com envios grandes para um projeto. Você só precisa concluir e enviar a documentação uma vez. Reveja cuidadosamente o documento. Talvez seja necessário que seu empregador assine o documento.

A assinatura do CLA não concede a você direitos de se comprometer com o repositório main, mas isso significa que as equipes de Publicação de Conteúdo do Desenvolvedor do Office e do Office Developer poderão examinar e aprovar suas contribuições. Você é creditado por seus envios.

As solicitações de pull normalmente são revisadas dentro de 10 dias úteis.

Use o GitHub, o Git e este repositório

Observação

A maioria das informações nesta seção pode ser encontrada em artigos [Ajuda do GitHub]. Se você estiver familiarizado com o Git e o GitHub, pule para a seção Contribuir e edite conteúdo para as especificidades do fluxo de código/conteúdo deste repositório.

Para configurar a bifurcação do repositório

  1. Configure uma conta GitHub para que você pode contribuir para esse projeto. Se você ainda não fez isso, vá para o GitHub e faça isso agora.

  2. Instale o Git no computador. Siga as etapas no tutorial [Configurar Git].

  3. Crie sua própria bifurcação para este repositório. Para fazer isso, na parte superior da página, escolha o botão Fork .

  4. Copie seu garfo para o computador. Para fazer isso, abra o Git Bash. No prompt de comando, digite:

    git clone https://github.com/<your user name>/<repo name>.git

  5. Em seguida, crie uma referência para o repositório raiz inserindo esses comandos:

        cd <repo name>
        git remote add upstream https://github.com/OfficeDev/<repo name>.git
        git fetch upstream

Parabéns! Agora você configurou seu repositório. Você não precisará repetir essas etapas novamente.

Contribuir e editar o conteúdo

Para tornar o processo de contribuição o mais contínuo possível, siga estas etapas.

Para contribuir e editar conteúdo

  1. Crie uma nova ramificação.
  2. Adicione novo conteúdo ou edite o conteúdo existente.
  3. Envie uma solicitação pull para o repositório principal.
  4. Exclua a ramificação.

Importante: limitar cada branch a um único conceito/artigo para simplificar o fluxo de trabalho e reduzir a chance de conflitos de mesclagem. O conteúdo apropriado para um novo branch inclui:

  • Um novo artigo.
  • Edições de ortografia e gramática.
  • Aplicando uma única alteração de formatação em um grande conjunto de artigos (por exemplo, aplicando um novo rodapé de direitos autorais).

Para criar um novo branch

  1. Abra o Git Bash.
  2. No prompt de comando do Git Bash, digite git pull upstream main:<new branch name>. Isso cria uma nova ramificação localmente copiada da ramificação mais recente do OfficeDev main.
  3. No prompt de comando do Git Bash, digite git push origin <new branch name>. Isso alerta o GitHub para o novo branch. Agora você deverá surgir a nova ramificação na sua bifurcação do repositório no GitHub.
  4. No prompt de comando do Git Bash, digite git checkout <new branch name> para alternar para seu novo branch.

Adicionar novo conteúdo ou editar o conteúdo existente

Navegue até o repositório em seu computador usando Explorador de Arquivos. Os arquivos do repositório estão em C:\Users\<yourusername>\<repo name>.

Para editar arquivos, abra-os em um editor de sua escolha e modifique-os. Para criar um novo arquivo, use o editor de sua escolha e salve o novo arquivo no local apropriado na cópia local do repositório. Durante o trabalho, salve seu trabalho com frequência.

Os arquivos em C:\Users\<yourusername>\<repo name> são uma cópia de trabalho do novo branch que você criou em seu repositório local. Qualquer que seja a alteração você faça nessa pasta, ela só afetará o repositório local quando você confirmar uma alteração. Para confirmar uma alteração no repositório local, digite os seguintes comandos no GitBash:

    git add .
    git commit -v -a -m "<Describe the changes made in this commit>"

O comando add adiciona suas alterações para uma área de preparo em preparação para confirmá-las no repositório. O período após o add comando especifica que você deseja encenar todos os arquivos que você adicionou ou modificou, verificando subpastas de forma recursiva. (Se você não quiser confirmar todas as alterações, poderá adicionar arquivos específicos. Você também pode desfazer um commit. Para obter ajuda, digite git add -help ou git status.)

O comando commit aplica as alterações preparadas ao repositório. A opção -m significa que você está fornecendo o comentário de confirmação na linha de comando. Os comutadores -v e -a podem ser omitidos. A opção -v é para saída verbosa do comando e -a faz o que você já fez com o comando add.

Você pode se comprometer várias vezes enquanto está fazendo seu trabalho ou pode se comprometer uma vez quando terminar.

Enviar uma solicitação pull para o repositório principal.

Quando terminar o trabalho e estiver pronto para mesclar o main repositório, siga estas etapas.

Para enviar uma solicitação de pull para o repositório main

  1. No prompt de comando do Git Bash, digite git push origin <new branch name>. Em seu repositório local, origin refere-se ao repositório do GitHub a partir do qual você clonou o repositório local. Esse comando coloca o estado atual do sua nova ramificação, incluindo todas as confirmações feitas nas etapas anteriores, na ramificação do GitHub.
  2. No site do GitHub, navegue em sua bifurcação para a nova ramificação.
  3. Escolha o botão Pull Request na parte superior da página.
  4. Verifique se o branch base é OfficeDev/<repo name>@main e o branch Principal é <your username>/<repo name>@<branch name>.
  5. Escolha o botão Atualizar Intervalo de Confirmação .
  6. Adicione um título à sua solicitação de pull e descreva todas as alterações que você está fazendo.
  7. Envie a solicitação pull.

Um dos administradores do site processará sua solicitação de pull. Sua solicitação de pull aparecerá no site de nome do OfficeDev/repositório em Problemas. Quando a solicitação de pull for aceita, o problema será resolvido.

Criar uma nova ramificação após a mesclagem

Depois que uma ramificação for mesclada com êxito (ou seja, sua solicitação de pull é aceita), não continue trabalhando nessa ramificação local. Isso pode levar a conflitos de mesclagem se você enviar outra solicitação de pull. Para fazer outra atualização, crie uma nova ramificação local a partir do branch upstream mesclado com êxito e exclua sua ramificação local inicial.

Por exemplo, se a ramificação local X foi mesclada com êxito no officeDev/microsoft-graph-docs main branch e você quiser fazer atualizações adicionais para o conteúdo que foi mesclado. Crie uma nova ramificação local, X2, do officeDev/microsoft-graph-docs main branch. Para fazer isso, abra o GitBash e execute os seguintes comandos:

    cd microsoft-graph-docs
    git pull upstream main:X2
    git push origin X2

Agora você tem cópias locais (em uma nova ramificação local) do trabalho enviado na branch X. O branch X2 também contém todo o trabalho que outros escritores mesclaram, portanto, se o trabalho depender do trabalho de outras pessoas (por exemplo, imagens compartilhadas), ele estará disponível no novo branch. Você pode verificar se o trabalho anterior (e o trabalho de outras pessoas) está no branch verificando o novo branch...

git checkout X2

... e verificando o conteúdo. (O checkout comando atualiza os arquivos no C:\Users\<yourusername>\microsoft-graph-docs estado atual do branch X2.) Depois de marcar o novo branch, você pode fazer atualizações no conteúdo e confirmá-las normalmente. No entanto, para evitar trabalhar na ramificação mesclada (X) por engano, o melhor a fazer será excluí-la (confira a seguinte seção: Excluir uma ramificação).

Excluir uma ramificação

Depois que suas alterações forem mescladas com êxito no repositório main, exclua o branch usado porque você não precisa mais dele. Qualquer trabalho adicional deve ser feito em um novo branch.

  1. No prompt de comando do Git Bash, digite git checkout main. Isso garante que você não fique na ramificação a ser excluída (o que não é permitido).
  2. Em seguida, no prompt de comando, digite git branch -d <branch name>. Isso exclui o branch em seu computador somente se ele tiver sido mesclado com êxito ao repositório upstream. (Você pode substituir esse comportamento com o sinalizador –D, mas primeiro certifique-se de que deseja fazer isso).
  3. Por fim, digite git push origin :<branch name> no comando prompt (um espaço antes dos dois pontos e nenhum espaço depois deles). Essa ação excluirá a ramificação em uma bifurcação do github.

Parabéns, você contribuiu com êxito para o projeto!

Usar Markdown para formatar seu tópico

Markdown

Todos os artigos neste repositório usam Markdown. Uma introdução completa (e a listagem de toda a sintaxe) podem ser encontradas em [Daring Fireball - Markdown].

Convenções de marcação & regras especificamente para este repositório

Consulte a referência do Docs Markdown em nosso guia de contribuidor.

Perguntas frequentes

Como obter uma conta do GitHub?

Preencha o formulário em Ingressar no GitHub para abrir uma conta gratuita do GitHub.

Onde posso obter um Contrato de Licença do Colaborador?

Você receberá automaticamente um aviso de que precisa assinar o CLA (Contrato de Licença do Colaborador) se sua solicitação de pull exigir uma.

Como membro da comunidade, você deve assinar o CLA (Contrato de Licença do Colaborador) antes de poder contribuir com envios volumosos para esse projeto. Você só precisa concluir e enviar a documentação uma vez. Reveja cuidadosamente o documento. Talvez seja necessário que seu empregador assine o documento.

O que acontece com meu contribuições?

Quando você enviar suas alterações, por meio de uma solicitação de pull, nossa equipe será notificada e examinará sua solicitação de pull. Você receberá notificações sobre sua solicitação de pull do GitHub; você também pode ser notificado por alguém da nossa equipe se precisarmos de mais informações. Se sua solicitação de pull for aprovada, atualizaremos a documentação. Reservamos o direito de editar seu envio para questões legais, de estilo, de clareza ou outras questões.

Posso me tornar um aprovador para as solicitações de pull do GitHub deste repositório?

Atualmente, não estamos permitindo que colaboradores externos aprovem solicitações de pull neste repositório.

Em quanto tempo vou receber uma resposta sobre minha solicitação de alteração?

As solicitações de pull normalmente são revisadas dentro de 10 dias úteis.

Mais recursos

  • Para saber mais sobre Markdown, acesse o site do criador do Markdown [Daring Fireball].
  • Para saber mais sobre como usar o Git e o GitHub, primeiro marcar a [Ajuda do GitHub].

GitHub HomeGitHub Ajudaa configurar GitDaring Fireball - MarkdownDaring Fireball