Skip to content

Commit 1d22327

Browse files
committed
Update "translations.md" with important guidelines
1 parent d0c77ac commit 1d22327

File tree

1 file changed

+116
-6
lines changed

1 file changed

+116
-6
lines changed
Lines changed: 116 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,121 @@
1-
# Translations
1+
# Traduzindo
22

3-
Vue has spread across the globe, with the core team being in at least half a dozen different timezones. [The forum](https://forum.vuejs.org/) includes 7 languages and counting and many of our docs have [actively-maintained translations](https://github.com/vuejs?utf8=%E2%9C%93&q=vuejs.org). We'are very proud of Vue's international reach, but we can do even better.
3+
Vue se espalhou pelo globo, com a equipe principal em pelo menos meia dúzia de fusos horários diferentes. O [fórum oficial](https://forum.vuejs.org/) inclui 7 idiomas e contando. Além disso, muitas de nossas documentações têm [traduções mantidas ativamente](https://github.com/vuejs?utf8=%E2%9C%93&q=vuejs.org). Temos muito orgulho do alcance internacional do Vue, mas podemos fazer ainda melhor.
44

5-
## Can we start translating Vue 3 docs?
5+
## Podemos mesmo traduzir a documentação do Vue 3?
66

7-
Yes! We are ready for translation!
7+
Sim! Estamos prontos para a tradução!
88

9-
## How can I get involved with translations?
9+
## Como posso me envolver com traduções?
1010

11-
The best way to get started is to check out [this pinned issue](https://github.com/vuejs/docs-next/issues/478) that contains active discussions on the various initiatives happening in the community.
11+
Digamos que você fale Esperanto e quer saber quais iniciativas de tradução já existem e como se envolver em uma delas, confira [esta _issue_ afixada](https://github.com/vuejs/docs-next/issues/478) que contém discussões ativas sobre as iniciativas de tradução da nova documentação pela comunidade.
12+
13+
### Como colaborar com a versão em português?
14+
15+
Mas se você está aqui, deve ser por falar português! Neste caso, para nos ajudar diretamente, intereja com a equipe em [nosso repositório de tradução](https://github.com/vuejs-br/docs-next).
16+
17+
::: tip
18+
Problemas pontuais em traduções já realizadas, como erros de grafia pequenos ou frases confusas, podem ser reportados apenas [criando uma _issue_](https://github.com/vuejs-br/docs-next/issues/new). Deixe claro sobre qual página se refere o problema e, preferencialmente, ofereça uma sugestão para a correção desejada.
19+
:::
20+
21+
Mas se você se sente à vontade para traduzir/revisar conteúdos inteiros por conta, os passos são:
22+
23+
- Verifique o que já está em [aberto nas _issues_](https://github.com/vuejs-br/docs-next/issues),
24+
- Se necessário, [crie uma _issue_](https://github.com/vuejs-br/docs-next/issues/new) cujo título contenha claramente o nome do arquivo alvo da tradução. Por exemplo: `Traduzir "guide/installation.md"`;
25+
- Na _issue_ alvo de seu trabalho, deixe um comentário avisando que está trabalhando nisso, para evitar trabalho duplicado por outros colaboradores.
26+
- Faça um _fork_ do _branch_ `master` deste _repo_ para sua própria conta,
27+
- Faça as traduções/revisões no(s) arquivo(s) que se propôs, usando o editor que quiser;
28+
- Recomendamos fortemente que faça uma revisão geral antes de considerar concluído, de preferência usando um corretor gramatical acoplado ao seu editor.
29+
- Ao finalizar, faça um _pull request_ para este _repo_ contendo o(s) arquivo(s) modificado(s) e **a descrição do _commit_ em inglês** (recomendação do _core team_),
30+
- Alguém da equipe de mantenedores do Vue.js Brasil vai avaliar seu _pull request_, eventualmente solicitar novos _commits_ se ainda precisar de algum ajuste e, depois de tudo pronto, liberar sua contribuição para o mundo.
31+
- **Gostou e quer mais?** Não se esqueça de fazer um _pull_ das alterações mais recentes antes de recomeçar o processo, já que a documentação original em inglês sempre sofre alterações e frequentemente fazemos a sincronização com o [_upstream_](https://github.com/vuejs/docs-next) para manter tudo em dia.
32+
33+
::: warning
34+
Se passar alguns dias desde que avisou sobre o trabalho que estava fazendo e não conseguir terminar, volte na _issue_ e avise a equipe: outras pessoas podem querer dar continuidade em seu trabalho! Neste caso, você poderá enviar um _pull request_ com a parte feita e deixar que outros façam novos _commits_ ali mesmo, até que o trabalho seja finalizado. Por favor, não abandone do nada o trabalho em um arquivo sem avisar ninguém, isso dificulta demais a organização do projeto!
35+
:::
36+
37+
## Recomendações para qualidade da tradução
38+
39+
Para uma documentação padronizada e de qualidade, seguimos alguns princípios e recomendações gerais sobre **o que fazer**:
40+
41+
- Traduzir os comentários dos códigos-fonte, sejam eles _inline_ `//` ou de múltiplas-linhas `/* */`;
42+
- Traduzir textos informativos dos códigos-fonte, por exemplo: `<div id="level-1">Nível 1</div>`;
43+
- Seguir maiúsculas e minúsculas conforme o original em inglês sempre que possível, exceto quando existir claramente uma regra de notaçãoo diferente na língua portuguesa;
44+
- Usar itálico em expressões sem tradução (por exemplo, _view layer_), exceto em nomes próprios grafados em maiúsculas (por exemplo, Internet);
45+
- Utilizar alguma extensão de ortografia e gramática vinculada ao seu editor de código, para evitar que erros deste tipo sejam submetidos;
46+
- Quando for submeter seu trabalho, sempre escreva a descrição do _commit_ em inglês (recomendação do _core team_).
47+
48+
E algumas recomendações sobre **o que não fazer**:
49+
50+
- Não traduzir nomes de variáveis, métodos, dados, _ids_, classes etc. nos códigos-fonte, ou seja, nada que afetaria a estrutura e a execução do código-fonte;
51+
- Não grafar em itálico tipos de dados ou valores primitivos (como true, false, String, Object);
52+
- Não modificar a estrutura dos arquivos `.md` traduzidos, ou seja, não mudar o local das quebras de linha, dos títulos, dos parágrafos, não remover quebras de linhha entre títulos e parágrafos, etc. Qualquer mudança neste sentido dificulta muito _merges_ futuros na hora de manter a documentação atualizada em relação à documentação em inglês.
53+
- Não fazer _pull_ diretamente do [_upstream_](https://github.com/vuejs/docs-next), este repositório da tradução é que deve ser alvo do seu _fork_ pessoal;
54+
- Não fazer _pull request_ diretamente para o [_upstream_](https://github.com/vuejs/docs-next), a tradução sempre acontece apenas neste repositório.
55+
56+
### Termos padronizados
57+
58+
Alguns termos recorrentes causam dúvidas aos novos colaboradores da tradução. Alguns são sempre traduzidos de certa forma, outros nunca são traduzidos. Veja como ficar dentro do padrão:
59+
60+
**Sempre traduzimos**
61+
62+
Devem ser traduzidos sempre da mesma maneira (a menos que sua tradução atrapalhe demais o contexto da frase, o que deve ser discutido na _issue_ correspondente):
63+
64+
- _Bundle_ = Pacote
65+
- _Debug_ = Depuração
66+
- _Handling_ = Manipulação
67+
- _Event Listening_ = Escuta de Eventos
68+
- _Render Function_ = Função de Renderização
69+
- _Computed Properties_ = Dados Computados
70+
- _Single-File Components_ = Componentes Single-File
71+
- _Custom Elements_ = Elementos Personalizados
72+
- _Performance_ = Desempenho
73+
- _Watchers_ = Observadores
74+
- _Under the hood_ = Em seu interior
75+
- _Server-Side Rendering_ = Renderização no Lado do Servidor
76+
- _Props_ = Propriedades
77+
- _Hooks_ = Gatilhos
78+
- _Bind_ = Vínculo ou Interligação
79+
80+
**Nunca traduzimos**
81+
82+
Atualmente, recomenda-se que os termos a seguir sejam mantidos em inglês, inclusive com a grafia em itálico ou sem itálico, conforme apresentado a seguir:
83+
84+
- _getter_
85+
- _setter_
86+
- _standalone_
87+
- _runtime_
88+
- _store_
89+
- _scaffolding_
90+
- _loader_
91+
- _loop_
92+
- _template_
93+
- _wrapper_
94+
- _hot-reload_
95+
- _open-source_
96+
- _framework_
97+
- _issue_
98+
- true
99+
- false
100+
- Number
101+
- String
102+
- Boolean
103+
- Array
104+
105+
**Traduzir mas manter o original**
106+
107+
Em alguns casos, para facilitar a compressão tanta por desenvolvedores menos experiências quanto mais experiências, alguns termos podem ser traduzidos mas com o original em inglês entre parênteses, por exemplo:
108+
109+
> A biblioteca principal é focada exclusivamente na camada visual (_view layer_) das aplicações.
110+
111+
Na dúvida, discuta na _issue_ correspondete ao arquivo que estiver trabalhando, para trocar opiniões com os mantenedores.
112+
113+
## Como escrever melhor?
114+
115+
O _core team_ criou um material vasto e interessante no [Guia de Escrita da Documentação](./writing-guide.md) para melhorar a escrita de conteúdos de documentação, o que também é muito relevante para que traduzir conteúdos. Passe um tempo por lá se inteirando das recomendações, certamente serão úteis para isto e para várias outras situações.
116+
117+
## Como discutir sobre a tradução?
118+
119+
Como indivíduos, estamos espalhados por aí entre as várias [comunidades Vue.js Brasil](https://github.com/vuejs-br/comunidades) existentes em várias plataformas/localidades. Pode procurar por qualquer mantenedor listado neste GitHub e vai acabar encontrando em algum (ou vários) destes locais.
120+
121+
Mas, para fins de organização da tradução, **não conduzimos discussões externas a este repositório**. Portanto, vale reforçar: se precisar conversar sobre a tradução, [crie uma _issue_](https://github.com/vuejs-br/docs-next/issues/new).

0 commit comments

Comments
 (0)