Contribuindo para documentação existente

Esta seção descreve como contribuir para a documentação existente, ou seja, a documentação que já foi publicada no site. Antes de começar a seguir este procedimento, certifique-se de cumprir todos os requisitos listados em Pré-requisitos.

Cada página da Documentação do Fedora inclui um link "Edit this Page" no topo. Para atualizações simples, as alterações podem ser enviadas diretamente da interface da web do Pagure. Para edições maiores ou mais complexas, você deve preparar e testar suas alterações offline antes de enviar.

Editando online no Pagure

  1. Clique no link "Edit this Page" para carregar a fonte da documentação. Você será levado ao repositório de conteúdo apropriado no Pagure.

  2. Acima da lista de fontes no lado direito, clique em "Fork and Edit". (Se você já criou um fork do repositório, este botão será rotulado como "Edit in your fork" e você pode pular para a próxima etapa.)

    1. Se ainda não estiver autenticado no Pagure, suas credenciais serão solicitadas.

    2. Aguarde a conclusão da operação. Pode ser necessário atualizar a página, pois ela nem sempre é atualizada automaticamente quando o processo é concluído.

  3. Assim que o arquivo for carregado em seu fork, faça todas as alterações necessárias no conteúdo, faça o commit delas para seu fork e prepare uma pull request (PR).

    1. Cada PR deve ser enviado de seu próprio branch em seu repositório. Sob o título "Branch" da interface de confirmação, selecione "New branch" e dê ao branch um nome curto e exclusivo.

    2. Preencha o formulário de mensagem de commit.

    3. Clique em "Commit changes" para criar o branch e salvar essas alterações em seu fork.

  4. Depois que o commit for salvo, a página será atualizada para uma lista de commits para seu fork.

  5. Para incluir alterações adicionais relacionadas, repita este processo e faça o commit delas para o mesmo branch.

  6. Quando estiver pronto, clique em "Create pull request" e preencha o formulário de PR para enviar seu branch para o repositório upstream.

Dicas de commit do Git
  • Ao nomear seu branch, use apenas letras ASCII, dígitos, hífenes (-) e sublinhados (_). O nome pode conter, mas não começar ou terminar com, pontos únicos (.). Espaços, pontos duplos (..) e muitas outras pontuações não são permitidos.

  • O título do commit é como sua edição será identificada no log do repositório para a página. O título sugerido, "Update nome do arquivo", é suficiente para pequenas edições. Para alguns conselhos sobre como escrever boas mensagens de commit, consulte commit.style por Tim Pope (autor do vim).

  • Use o campo "Commit Description" para fornecer detalhes adicionais, se necessário, mas seja breve. Você terá a oportunidade de explicar ou discutir suas alterações ao enviar seu PR.

Edição offline

  1. Clique no link "Edit this Page" para carregar a fonte da documentação. Você será levado ao repositório de conteúdo apropriado no Pagure. Depois de localizar o repositório correto, faça um fork se ainda não tiver feito isso:

    1. No canto superior direito, clique em Fork.

    2. Se ainda não estiver autenticado no Pagure, suas credenciais serão solicitadas.

    3. Aguarde a conclusão da operação. Pode ser necessário atualizar a página, pois ela nem sempre é atualizada automaticamente quando o processo é concluído.

    4. Clone seu fork.

  2. Faça checkout de um novo branch e adicione suas contribuições.

  3. Se você adicionou novos arquivos, certifique-se de que eles sejam incluídos em um local razoável no arquivo de configuração nav.adoc do repositório

  4. Construa localmente e certifique-se de que tudo esteja como você espera. Consulte Construindo uma pré-visualização local para obter instruções.

  5. Uma vez finalizada, efetue o commit de suas alterações e o push delas para seu fork.

  6. Use o Pagure para fazer uma pull request de seu fork ao branch master do repositório principal.

Gerenciando sua pull request

Alguém verá sua pull request e a mesclará ou fornecerá feedback se houver algo que você deva alterar. Trabalhe com as pessoas que estão comentando para garantir que suas contribuições estejam de acordo com os padrões.

Se ninguém reagir à sua pull request após vários dias, tente levantar a questão em uma das reuniões semanais, no canal IRC (#fedora-docs no FreeNode) ou na lista de discussão.

Suas alterações aparecerão online algum tempo depois que a pull request for mesclada. O site está sendo atualizado diariamente. Se suas alterações não aparecerem online dentro de 60 horas após o seu PR ser mesclado, ping o asamalik (Adam Šamalík) no canal IRC e pergunte a ele sobre isso.