Esse projeto é uma iniciativa do CocoaHeads Brasil que tem como objetivo traduzir o livro oficial de Swift da Apple para o Português Brasileiro.
Link do livro original: Swift.org
- Os capítulos disponíveis para tradução serão criados como issues no GitHub;
- Os arquivos .md estão criados com o nome de cada capítulo. Ex.:
bemvindo/sobre.md
- Caso queira contribuir com a tradução, crie uma issue com o formato
<seção> - <capítulo>
(ex.:Bem-vindo ao Swift - Sobre o Swift
), adicione a tagtradução
e comente na issue avisando, para não haver traduções múltiplas do mesmo arquivo. - Crie uma branch para determinado arquivo que queira traduzir e faça o Pull Request.
- Palavras em inglês que não forem traduzidas, colocar em itálico;
- Código inline colocar entre crases para ficar alo como: defina um constante de tipo
String
e valor"John Appleseed"
; - Código em bloco deve conter syntax highlight do Swift;
- Traduzir termo técnico apenas se fizer sentido. Se for prejudicar o entendimento, é preferível manter o termo original. ex.: Closures. Existe uma ferramenta para tradução de terminologias da Microsoft; se fizer sentido utiliza-la para tirar dúvidas, utilize-a!
- Notas de rodapé devem ser criadas como quote do markdown, usando o sinal de
>
na frente; - Não esqueça de habilitar o verificador ortográfico do seu editor. Isso poupa muito tempo de que está revisando. Editores preferidos: MacDown ou Mou.
Caso queira visualizar como está ficando o texto, basta utilizar o Gitbook. Para isso, siga as instruções na nossa [página do wiki] (https://github.com/CocoaHeadsBrasil/the-swift-programming-language-in-portuguese-br/wiki).
- Crie um Pull Request com o título no formato:
<seção> - <capítulo>
(ex.:Bem-vindo ao Swift - Sobre o Swift
) e adicione as tagstradução
&& (parcial
||completa
) - Um (ou mais de um) revisor verifica o Pull Request;
- Se achado erro de tradução ou erro de português, o revisor comenta na linha;
- O criador do PR corrige ou responde se achar que não faz sentido, se discorda ou se tiver algo mais a acrescentar;
- Se o criador do PR enviar alguma atualização, voltamos para o item (1);
- Se a tradução estiver OK, o revisor comenta no final do PR com um 👍;
- Após ao menos 2 revisões feitas, é feito o merge da tradução.
The Swift Programming Language - Tradução Português (BR) de CocoaHeads Brasil está licenciado com uma Licença Creative Commons - Atribuição-CompartilhaIgual 4.0 Internacional.
Baseado no trabalho disponível em https://github.com/CocoaHeadsBrasil/the-swift-programming-language-in-portuguese-br.