Pode fazer uma doação ao Programming Historian

Directrizes para Tradutores

Uma mulher numa mesa escrevendo.

Etapa 1: Propor a tradução de uma lição

Etapa 2: Escrever e formatar uma tradução

Etapa 3: Submeter uma lição traduzida

Propor a tradução de uma lição

Se deseja traduzir uma lição publicada no Programming Historian, consulte a lista de traduções pendentes e entre em contato com Eric Brasil para apresentar as suas competências no idioma e experiência de tradução. Procuramos traduções rigorosas, legíveis e que considerem as necessidades de um público que lê português.

Depois da tradução ser aprovada, um de nossos editores criará um “Ticket de Revisão de Tradução” no nosso repositório do GitHub, onde a revisão por pares será realizada. Esse ticket inclui um quadro de mensagens, que será usado para documentar o progresso feito durante a revisão da tradução. Para evitar atrasos na publicação, solicitamos que envie sua tradução dentro de 90 dias após a proposta ser aceite pelo editor.

Traduzir uma lição

A tradução de uma lição envolve as seguinte atividades:

Ao realizar a tradução é importante ter em conta uma audiência global da comunidade de língua portuguesa. Para questões de estilo e escolha da linguagem, tenha em consideração a compatibilização e o glossário desenvolvido pela equipe.

Todas as nossas lições também devem ser escritas em Markdown e seguir as nossas Directrizes técnicas de formatação, também disponíveis nas Directrizes para Autores.

Submeter uma lição traduzida

Depois do ficheiro de tradução ter as especificações acima mencionadas, estará pronto a ser enviado para revisão por pares.

Temos uma página do Programming Historian em português no GitHub, onde mantemos dois repositórios (um repositório é um local para armazenar ficheiros e pastas relacionados, ou seja, um tipo de pasta). Um deles, chamado jekyll, hospeda o código da versão online do site disponível em http://programminghistorian.org. O outro repositório é chamado ph-submissions.

A melhor maneira para enviar uma tradução é adicioná-la diretamente ao repositório ph-submissions. Graças aos recursos do GitHub, pode fazer isso usando ações de arrastar e soltar, com as quais provavelmente já está familiarizado. Para os novos tradutores, estas são as etapas:

  1. Criar uma conta gratuita no GitHub. Demora cerca de 30 segundos.
  2. Enviar um e-mail ao editor com o seu novo nome de usuário no GitHub e o nome da lição a ser traduzida. O editor vai adicioná-lo como colaborador no repositório ph-submissions. Depois poderá fazer alterações diretas no repositório ph-submissions, incluindo adicionar, editar, remover e renomear ficheiros. O editor também criará uma pasta com o mesmo nome da sua lição na pasta de imagens. (Se tiver outros ficheiros de dados a vincular ao tutorial pergunte ao editor sobre eles.)
  3. Depois do editor confirmar que já está como colaborador, já vai conseguir navegar até à pasta pt/licoes/traducoes do repositório ph-submissions. Em seguida, arraste e solte o arquivo markdown da sua lição do seu computador para a janela do navegador (se precisar de ajuda, consulte as instruções do GitHub). Por fim, clique no botão verde “Commit changes”; não precisa de alterar a mensagem padrão.
  4. Pode ter algumas imagens que acompanham a lição. Nesse caso, verifique se todos os ficheiros são nomeados adequadamente, de acordo com as nossas regras de nomenclatura definidas na pasta de imagens do repositório ph-submissions. Clique na pasta com o mesmo nome da lição (criada pelo seu editor; se não a encontrar, entre em contato com o editor e aguarde instruções) e arraste e solte todos os seus ficheiros de imagens na janela do navegador, conforme descrito na na etapa 3. Não pode arrastar uma pasta de imagens, mas pode arrastar vários ficheiros de uma só vez.
  5. Pré-visualizar a lição! Aguarde alguns minutos (geralmente menos) para o GitHub converter o seu ficheiro Markdown em HTML e torná-lo numa página web. Em seguida, basta experimentar o link http://programminghistorian.github.io/ph-submissions/pt/esbocos/traducoes + NOME-DA-SUA-LICAO mas substitua NOME-DA-SUA-LICAO pelo nome do seu ficheiro de tradução).
  6. Informar o editor que os ficheiros da lição estão no repositório ph-submissions (os editores recebem uma notificação, mas é mais seguro que sejam avisados).
Se está familiarizado com o uso de comandos em linha do git e do GitHub, também pode enviar sua tradução e imagens como um _pull request_ no repositório `ph-submission` e fazer commit desde que esteja colocado como colaborador. Não envie lições por _pull request_ para o repositório principal Jekyll, para que possamos visualizar as lições em andamento antes de serem publicadas.

Tradução enviada! E agora?

Para ver o que acontece após o envio de uma tradução, consulte as Directrizes para Editores, que detalham o nosso processo editorial. Os pontos essenciais estão abaixo:

A etapa seguinte mais importante é que seu editor crie um ticket para a nova tradução no repositório ph-submissions, com um link para a sua lição (que visualizou na etapa 5). O editor e pelo menos dois revisores (convidados pelo editor) irão comentar.

Aguardar comentários do revisor

O nosso objetivo é concluir o processo de revisão dentro de quatro semanas, mas às vezes ocorrem atrasos ou as pessoas ficam ocupadas, pelo que o processo pode demorar mais do que esperávamos.

Seguindo os ideais da investigação académica pública e de revisão aberta por pares, incentivamos as discussões a permanecer no GitHub, para serem abertas a todos. No entanto, também queremos que todos se sintam confortáveis com o processo. Se precisar de discutir algo em particular, não hesite em enviar um e-mail diretamente ao seu editor ou entre em contato com o nosso mediador independente.

Responder aos comentários

YO editor e os revisores provavelmente farão algumas sugestões de melhoria no ticket da sua tradução. O editor deve esclarecer quais sugestões são essenciais, quais são opcionais e quais podem ser deixadas de lado.

Os ficheiros podem ser editados directamente no GitHub, seguindo as orientações.

As suas revisões devem ser concluídas dentro de 4 semanas após ter recebido as orientações do editor sobre como responder à revisão por pares. Isso é para garantir que as traduções são publicadas em tempo útil e que não se arrastam desnecessariamente. Se tiver problemas para cumprir o prazo, entre em contacto com seu editor para estabelecer uma data de submissão mais adequada.

Se, a qualquer momento, você não tiver a certeza da sua função ou o que fazer a seguir, sinta-se à vontade para enviar um e-mail ao seu editor ou, melhor ainda, enviar uma pergunta no ticket (outro editor poderá vê-lo e ajudá-lo antes do seu próprio editor). Pedimos compreensão pois, às vezes, levamos alguns dias para responder, mas esperamos que as melhorias na lição concluída valham a espera.

Informar o editor que terminou

Depois de responder aos comentários informe o seu editor. Se a equipe estiver satisfeita com a lição nesta fase, o Editor Chefe do Programming Historian em português fará uma última revisão da sua lição e passará os ficheiros do repositório ph-submissions para o repositório jekyll. Por fim, atualizará o diretório de lições onde será publicada.