Skip to content

Commit 8fb2fe9

Browse files
Update README and CONTRIBUTING
Update README and CONTRIBUTING Contribution done by: @nazarepiedady, @peruibeloko, @jonnathan-ls
2 parents 123d22a + 55c40f9 commit 8fb2fe9

File tree

3 files changed

+94
-56
lines changed

3 files changed

+94
-56
lines changed

AUTHORING.md

Lines changed: 0 additions & 37 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Contribuições
2+
3+
Esse documento contém recomendações de como contribuir com traduções para o tutorial.
4+
5+
## Passo a passo
6+
7+
1. Abra a issue #1
8+
1. Escolha um artigo sem atribuição
9+
1. Adicione um novo comentário na issue com o nome do artigo **exatamente** como está na lista
10+
1. Crie um fork do repositório e traduza o conteúdo do artigo, isso inclui os exercícios
11+
1. Abra um pull request com o título idêntico ao usado no comentário.
12+
13+
> [!TIP]
14+
> Segure a tecla <kbd>Alt</kbd> para selecionar o texto de um link sem acessar a página
15+
16+
## Traduções
17+
18+
Ao traduzir qualquer texto, mantenha algumas considerações em mente:
19+
20+
**Uma tradução verbatim (literal, palavra por palavra) normalmente não auxilia no entendimento do conteúdo.** Lembre-se: Estamos contribuindo com um tutorial! O mais importante é oferecer um texto de fácil compreensão. Expressar os conceitos de maneira clara é mais importante do que uma correspondência exata ao texto original.
21+
22+
**Evite usar serviços de tradução para trechos inteiros**. Se o trabalho de tradução fosse algo tão trivial quanto usar uma ferramenta automatizada, não teríamos todo esse trabalho, não é mesmo? Quando estiver com dificuldades para traduzir um trecho ou um termo, considere as seguintes alternativas:
23+
24+
1. Qual a ideia que o texto apresenta? Tente expressar essa ideia usando suas próprias palavras (usando sempre do bom senso, claro).
25+
1. Peça ajuda a outras pessoas! É um trabalho colaborativo no final das contas.
26+
1. Talvez parte do texto seja uma expressão popular que não possui uma equivalência exata. Nesses casos a dica 1 é bem útil. Busque entender a expressão na língua original para realizar a tradução.
27+
1. Ao invés de usar um serviço de tradução direta, procure o termo em alguma enciclopédia online na língua original, e mude a página para a sua língua de destino em seguida. Isso é bem útil para traduzir termos técnicos!
28+
29+
> [!NOTE]
30+
> Independente do que escolher, lembre-se que a recomendação é contra *trechos inteiros*. Nada impede você de usar esses serviços para traduzir um termo isolado, ou buscar sinônimos de uma tradução que você já conheça.
31+
32+
**Gramática e concordância são importantes, mas não deixe que isso te impeça de contribuir!** É para isso que temos o processo de revisão em duas etapas. Duas pessoas diferentes vão revisar sua contribuição e sugerir mudanças antes de qualquer coisa ser integrada do projeto de fato. É uma ótima oportunidade para você aprender mais sobre as línguas também!
33+
34+
**É um tutorial que te ensina JavaScript, não um documento oficial.** Repare que em diversos momentos do texto o próprio autor usa de expressões, maneirismos e passagens descontraídas. Claro, como mencionado acima, gramática é importante! Mas não precisamos usar uma linguagem tão formal - Priorize o entendimento!
35+
36+
**E o mais importante, conte conosco!** Somos uma *comunidade* num esforço *coletivo* em benefício de *toda a comunidade lusófona*. Em caso de dúvidas, não exite em abrir uma issue.
37+
38+
> [!CAUTION]
39+
> Os artigos contam com uma sintaxe específica do tutorial para certos elementos: `pattern:`, `subject:`, `match:`, etc. Os termos antes do `:` não devem ser traduzidos.
40+
41+
## Links internos
42+
43+
Todos os links do tutorial devem ser relativos e começar da raiz, sem o domínio.
44+
45+
✅ Correto:
46+
47+
```md
48+
Abordaremos isso no capítulo [sobre funções](/function-basics)
49+
```
50+
51+
❌ Errado:
52+
53+
```md
54+
Abordaremos isso no capítulo [sobre funções](https://javascript.info/function-basics)
55+
```
56+
57+
Além disso, para referenciar um capítulo, há uma sintaxe especial "info:":
58+
59+
```md
60+
Abordaremos isso no capítulo <info:function-basics>.
61+
```
62+
63+
Que torna-se:
64+
65+
```html
66+
Abordaremos isso no capítulo <a href="/function-basics">Funções básicas</a>.
67+
```
68+
69+
O título é inserido automaticamente a partir do artigo referenciado. Isso tem a vantagem de manter o título correto se o artigo for renomeado.
70+
71+
## TODO
72+
73+
Pergunte a @iliakan para mais detalhes.

README.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,40 @@
1-
# The Modern JavaScript Tutorial
1+
# O Tutorial Moderno de JavaScript
22

3-
This repository hosts the English content of the Modern JavaScript Tutorial, published at [https://javascript.info](https://javascript.info).
3+
Este repositório hospeda o conteúdo em português do Modern JavaScript Tutorial, publicado em [https://javascript.info](https://javascript.info).
44

5-
## Translations
5+
## Traduções
66

7-
We'd like to make the tutorial available in many languages. Please help us to translate.
7+
Gostaríamos de disponibilizar o tutorial em vários idiomas. Por favor, ajude-nos a traduzir.
88

9-
See <https://javascript.info/translate> for the details.
9+
Acesse <https://javascript.info/translate> para mais detalhes.
1010

11-
## Contributions
11+
## Contribuições
1212

13-
We'd also like to collaborate on the tutorial with other people.
13+
Também gostaríamos de colaborar no tutorial com outras pessoas.
1414

15-
Something's wrong? A topic is missing? Explain it to people, add it as PR 👏
15+
Algo está errado? Falta um tópico? Explique para as pessoas, adicione como PR 👏
1616

17-
**You can edit the text in any editor.** The tutorial uses an enhanced "markdown" format, easy to grasp. And if you want to see how it looks on-site, there's a server to run the tutorial locally at <https://github.com/javascript-tutorial/server>.
17+
**Você pode editar o texto em qualquer editor.** O tutorial usa um formato "markdown" aprimorado, fácil de entender. E se você quiser ver como fica no site, há um servidor para executar o tutorial localmente em <https://github.com/javascript-tutorial/server>.
1818

19-
The list of contributors is available at <https://javascript.info/about#contributors>.
19+
A lista de contribuidores está disponível em <https://javascript.info/about#contributors>.
2020

21-
## Structure
21+
Para saber como contribuir, leia o nosso [Guia de Contribuição](/CONTRIBUTING.md)
2222

23-
Every chapter, article, or task has its folder.
23+
## Estrutura
2424

25-
The folder is named like `N-url`, where `N` is a number for the sorting purposes and `URL` is the URL part with the title of the material.
25+
Cada capítulo, artigo ou tarefa tem sua pasta.
2626

27-
The type of the material is defined by the file inside the folder:
27+
A pasta é nomeada como `N-url`, onde `N` é um número para fins de classificação e `URL` é a parte da URL com o título do material.
2828

29-
- `index.md` stands for a chapter
30-
- `article.md` stands for an article
31-
- `task.md` stands for a task (solution must be provided in `solution.md` file as well)
29+
O tipo do material é definido pelo arquivo dentro da pasta:
3230

33-
Each of these files starts from the `# Main header`.
31+
- `index.md` significa um capítulo
32+
- `article.md` significa um artigo
33+
- `task.md` representa uma tarefa (a solução também deve ser fornecida no arquivo `solution.md`)
3434

35-
It's very easy to add something new.
35+
Cada um desses arquivos começa no `# Cabeçalho principal`.
36+
37+
É muito fácil adicionar algo novo.
3638

3739
---
3840

0 commit comments

Comments
 (0)