diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f9384d9..e1f9848 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,21 +9,33 @@ Bom, se você quer cooperar com a tradução da documentação, basta você ir n Basta você entrar numa `issue` e comentar qual tópico ou quais tópicos você pretende ter a **responsabilidade** de traduzir. Pedimos que essa parte seja levada bem à sério, já que, uma vez separada a tradução do tópico para você, outra pessoa não irá fazer. -A partir do seu comentário, um dos nossos contribuidores vai colocar seu usuário na frente do tópico escolhido. +A partir do seu comentário, um dos nossos contribuidores vai colocar seu usuário na frente do tópico escolhido. Veja nesse [exemplo](https://github.com/IonicBrazil/ionic2-docs/issues/8). Depois disso, é só você `forkar` o nosso repositório e escrever suas traduções. ## Enviando as traduções +### Commits +Commitar apenas os arquivos que estão sendo modificados, **NÃO** utilizar `git add .` e **SIM** `git add nome_arquivo`. Assim poderemos evitar possíveis conflitos na hora do PR. + + ### Pull request -Depois que tiver terminado suas traduções, você só precisa fazer um `pull request` para nosso repositório. -Em relação aos `pull requests`, pedimos que sejam enviados da forma mais simples possível. O que queremos dizer é que seja enviando tópico por tópico. Dessa forma, tornamos o processo de revisão e correção mais dinâmico e mais rápdido possível. +Depois que tiver terminado suas traduções, você só precisa fazer um `pull request` para nosso repositório. + +Em relação aos `pull requests`, pedimos que sejam enviados da forma mais simples possível. O que queremos dizer é que seja enviando tópico por tópico. Dessa forma, tornamos o processo de revisão e correção mais dinâmico e mais rápdido possível. + +Ao criar um novo PR, seguir os padrões abaixo: -Não esqueçam de linkar no [README](https://github.com/IonicBrazil/ionic2-docs/blob/master/README.md) principal e também no README de cada capítulo, os arquivos dos tópicos que você enviar. +**1. Nome do PR:** [Para Revisão] - Capítulo x - Nome do Capítulo - Nome do Subcapítulo +**2. Conversation:** Mencionar o @juarezpaf no PR +**2.1 Conversation:** Caso você tenha encontrado alguma dificuldade em algum termo, citá-lo. Exemplo: *o termo build não me senti totalmente à vontade em traduzir para compilar. O que vocês acham, mantenho como build em inglês ou deixo compilar?* -### Revisão +Não esqueçam de linkar no [README](https://github.com/IonicBrazil/ionic2-docs/blob/master/README.md) principal e também no README de cada capítulo, os arquivos dos tópicos que você enviar. + +Lembrando, não creim PR que possuam conflitos. Caso, ao criar seu PR seja encontrado algum conflito, por favor, resolvam os conflitos primeiramente antes de criar o PR. Só serão aceitos PR para revisão hábeis para merge, com confitos serão fechados imediatamente. + +### Revisão Em seguida, um de nossos contribuidores vai analisar todo o texto para ver se está tudo correto. Passando dessa parte, é feito um `merge` da sua tradução. No final de tudo, você ajudou a comunidade Ionite. -