1. Faça o fork do projeto.
3. Leia e pratique as boas práticas.
4. Veja nas issues o status, através das labels, do capítulo que você deseja traduzir ou revisar.
5. Caso o capítulo ainda não esteja em tradução ou revisão, comente na Issue correspondente que você irá iniciar tal tarefa, para que assim possamos atribuir o capítulo para você.
IMPORTANTE: Adquira a concessão para tradução de outro capítulo somente APÓS terminar o anterior solicitado.
- em tradução: sinaliza que um arquivo está em tradução.
- aguardando revisão: sinaliza que o capítulo já foi traduzido e está esperando para ser revisado.
- em revisão: sinaliza que um arquivo traduzido está sendo revisado.
- aguardando supervisão: sinaliza que um arquivo que já foi traduzido e revisado está esperando uma última revisão antes de ser finalizado.
- em supervisão: sinaliza que um arquivo já traduzido e revisado está recebendo uma última revisão antes de ser finalizado.
- dúvidas: dúvidas, sugestões e outros.
O andamento das Issues está divido em 5 etapas na ordem apresentada abaixo:
em tradução > aguardando revisão > em revisão > aguardando supervisão > em supervisão > fechamento da issue
Ao mostrar-se interessado por uma Issue seguiremos as regras:
1. A Issue será atribuida ao interessado.
2. Colocaremos uma milestone com o prazo de 2 semanas para entrega do Pull Request.
3. Quando o prazo da milestone vencer, nós verificaremos a atividade da Issue, caso necessário estenderemos o prazo para mais 2 semanas.
4. Quando o prazo da milestone vencer e não houver nenhuma atividade correspondente a Issue, entraremos em contato com responsável pela própria Issue. Caso a pessoa não se manifestar no prazo de 14 dias, a Issue retrocederá ao estado anterior, de acordo com as etapas citadas acima.
1. Faça referência ao repositório oficial após o fork
git remote add upstream [email protected]:braziljs/eloquente-javascript.git
2. Antes de iniciar o processo de tradução, crie uma branch com um nome coerente com o que estiver fazendo, Exemplo:
- Para tradução:
git checkout -b c0x
- Para revisões:
git checkout -b c0xr0y
xrepresenta o número do cápitulo eyo número da review.
3. Após a tradução ou revisão de um cápitulo é hora de fazer um commit com uma mensagem bem coerente do que foi feito. Exemplo:
git add --all
git commit -am 'Tradução do tópico foo do capítulo 1 #numero-da-issue'
git push origin c0xr0y
ps: Lembre de sempre fazer a referência da issue que representa o capítulo em tradução/revisão na hora do commit.
Ex:
git commit -m 'Tradução capítulo 13 - DOM #13'
Caso queira enviar o Pull Request do que foi feito, abra-o referenciando para a master do repositório oficial.
4. Após finalizar a tradução ou revisão de uma Issue siga os passos:
- Delete a branch utilizada:
git checkout master
git push origin :c0xr0y
git branch -D c0xr0y
- Atualize seu repositório com o repositório oficial:
git fetch upstream
git rebase upstream/master
git push -f origin master
5. Quando for iniciar uma nova tradução ou revisão, inicie todo processo pelo passo 2.
Quando estiver em uma situação em que você não sabe exatamente como traduzir uma palavra, termo ou expressão, nós recomendamos que siga os seguintes passos:
1. Abra uma Issue com um título descritivo como por exemplo: "Como traduzir a palavra/termo "x"?" e coloque uma descrição fazendo referência a Issue do capítulo que você está trabalhando e explicando o contexto com informações relevantes.
2. Adicione um label [TODO: ref #<número-da-issue-da-discussão>]<palavra/termo não traduzido>[/TODO] e continue trabalhando no arquivo enquanto não há uma conclusão na Issue. Esse processo é importante para facilitar o acesso a itens pendentes e ter uma referência clara onde está ocorrendo a discussão.
3. Após a conslusão da discussão na Issue, feche a mesma. Em seguida, remova o label adicionado no passo 2 e atualize a palavra/termo não traduzido.
4. Como mantemos um arquivo de glossário, faça um Pull Request adicionando o novo termo, colocando a referência #<número-da-issue> no termo/palavra em questão para fácil acesso no futuro.
Quando algum revisor achar que alguma mensagem de commit não estiver coerente, ele pode pedir para você esmagar seus commits. Mais informações você encontra aqui.
Apenas os textos, códigos e termos técnicos permanecem intactos.
Obrigado! ❤️ ❤️ ❤️