Este é o repositório oficial da tradução em português brasileiro do site vuejs.org. O site foi construído com hexo e o conteúdo escrito em formato Markdown na pasta src
. Pull requests são bem-vindos!
Veja o Guia de Escrita de Docs do Vue para nossas regras e recomendações ao escrever e manter documentação.
$ npm install
$ npm start # servidor executando em http://localhost:4000
O site é automaticamente publicado quando commits chegam em master
, via Netlify.
O processo é disparado somente por um grupo seleto de contribuidores que podem atualizar o branch master
, a fim de manter a organização. Você pode colaborar enviando pull requests para o branch dev
e, depois de revisados e aceitos, serão mesclados em master
pela equipe, para que o deploy automático ocorra.
Problemas pontuais nas traduções já realizadas, como erros de grafia ou frases confusas, podem ser reportados apenas enviando issues neste repositório. Deixe claro sobre qual página se refere o problema e, preferencialmente, ofereça uma sugestão para a correção desejada.
Se você se sente à vontade para traduzir/revisar conteúdos por conta, os passos são:
- Verifique o que está em aberto nas issues,
- Se necessário, crie uma issue neste repo para informar o que está fazendo;
- Faça um fork do branch
dev
deste repo para sua própria conta,- Como o branch
dev
é utilizado para sincronizar as atualizações do repositório original em inglês, muitas vezes existem conflitos de merge para corrigir! Se estiver em dúvida se há onde ajudar no momento, procure por conflitos de merge no branchdev
.
- Como o branch
- Faça as traduções/revisões nos arquivos que se propôs, usando o editor que quiser;
- Ao finalizar, faça um pull request para
dev
com a descrição do commit em inglês; - Não se esqueça de obter as alterações mais recentes antes de recomeçar o processo.
Caso não consiga terminar por completo algum arquivo, mas queira enviar o trabalho parcial, deixe isso claro na issue de seu trabalho após a submissão, para informar quais problemas persistem no arquivo enviado.
Para uma documentação padronizada, seguem recomendações do que fazer:
- Traduzir os comentários dos códigos-fonte;
- Traduzir textos informativos dos códigos-fonte, por exemplo:
<div id="level-1">Nível 1</div>
; - Seguir maiúsculas e minúsculas conforme o original em inglês sempre que possível;
- Utilizar alguma extensão para ortografia e gramática, para evitar que erros deste tipo;
- Usar itálico em expressões sem tradução (por exemplo, view layer);
- Quando for submeter, sempre escreva os comentários do commit em inglês.
E algumas recomendações do que não fazer:
- Não traduzir nomes de variáveis, métodos, dados, ids, classes etc. nos códigos-fonte.
- Não grafar em itálico tipos de dados ou valores primitivos;
- Não faça pull request diretamente para
vuejs/master
, a tradução deve passar por esse repositório. - Não faça pull diretamente de
vuejs/master
, apenas deste repositório para seu fork pessoal.
Alguns termos recorrentes no guia devem ser traduzidos sempre da mesma maneira, desde que a tradução não atrapalhe o contexto da frase:
- Bundle = Pacote
- Debug = Depuração
- Handling = Manipulação
- Event Listening = Escuta de Eventos
- Render Function = Função de Renderização
- Computed Properties = Dados Computados
- Single-File Components = Componentes Single-File
- Custom Elements = Elementos Personalizados
- Performance = Desempenho
- Watchers = Observadores
- Under the hood = Em seu interior
- Server-Side Rendering = Renderização no Lado do Servidor
- Hooks = Gatilhos
- Bind = Vínculo (ou Interligação)
Atualmente recomenda-se que estes termos sejam mantidos em inglês:
- getter
- setter
- standalone
- runtime
- store
- scaffolding
- loader
- loop
- template
- wrapper
- hot-reload
- true
- false
- Number
- String
- Boolean
- Array
Se você não chegou até aqui para colaborar, mas sim para pedir ajuda sobre alguma coisa da documentação oficial do Vue, a Comunidade Brasileira criou uma lista com todos locais oficialmente reconhecidos. Saiba que a comunidade Vue é muito receptiva (no Brasil e no mundo), então não se acanhe para se envolver mais.
Nós temos o nosso fórum em português sobre o Vue, basta clicar aqui. Este fórum está no próprio GitHub, e usamos o gerenciamento de issues como um sistema de fórum. Também temos um chat no Slack destinado especificamente à comunidade brasileira, caso você queira uma interação mais direta com outros adeptos do Vue.