Skip to content

Commit 62cb370

Browse files
longo-andrealongo-andrea
authored
Merge pull request #135 from longo-andrea/docs
Update README
2 parents 89aea2e + cb00c2e commit 62cb370

File tree

2 files changed

+127
-62
lines changed

2 files changed

+127
-62
lines changed

‎CONTRIBUTING.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# The Modern JavaScript tutorial in Italiano
2+
Ciao a tutti! Questa è la traduzione italiana del tutorial [The Modern JavaScript Tutorial
3+
](https://javascript.info/).
4+
5+
Se volete contribuire alla traduzione del tutorial, inanzitutto date un'occhiaata al [README.md](./README.md) per maggiori dettagli.
6+
7+
Per una coordinazione più rapida ed informale abbiamo creato un canale Discord, a puoi unirti per discutere di qualsiasi cosa riguardante la traduzioni o anche solo per chiedere informazioni su come inziare.
8+
9+
- **[Canale Discord](https://discord.gg/Dj9P3jCt6K)**
10+
11+
## Come contribuire
12+
Se vuoi contribuire alla traduzione di un articolo:
13+
14+
1. Esegui un `fork` di questo repository, in modo da poter effettuare le lavorazioni in locale
15+
16+
2. Scegli l'articolo che desideri tradurre e notificalo ai maintainer lasciando un commento nell'apposita [issue](https://github.com/javascript-tutorial/it.javascript.info/issues/1), in questo modo evitiamo sovrapposizioni.
17+
18+
3. Traduci l'articolo scelto. Ti ricordo nuovamente di leggere il [README.md](./README.md) per informazioni su cosa tradurre e cosa non tradurre, come tradurre termini particolari, etc...
19+
20+
4. Una volta terminata la traduzione dell'articolo ti chiedo di effettuare una rapido controllo ortografico, in modo da velocizzare le operazioni di revisione. Puoi farlo con un qualsiasi tool gratuito online.
21+
22+
- [Language Tool](https://languagetool.org/)
23+
24+
5. Una volta terminata la traduzione inoltra una `Pull Request` sul branch `master`.
25+
26+
6. (Opzionale) Informa i maintainer della tua PR tramite il canale Discord in modo da velocizzare la presa in carico.
27+

‎README.md‎

Lines changed: 100 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,98 +1,136 @@
11
# The Modern JavaScript Tutorial in italiano
22

3-
In questa repository viene pubblicata la traduzione italiana di [https://javascript.info](https://javascript.info).
3+
Benvenuti a tutti i nuovi contributors! 👋
44

5-
Ci piacerebbe rendere questo tutorial disponibile in molte lingue. Aiutaci a tradurlo.
5+
In questa repository viene puubblica la traduzione italiana del tutorial [javascript.info](https://javascript.info).
66

7-
Guarda il link <https://github.com/javascript-tutorial/translate> per maggiori dettagli.
7+
Ci piacrebbe ricevere il tuo contributo nella traduzione e/o revisione degli articoli.
88

9-
Ci piacerebbe anche ricevere la vostra collaborazione nel tutorial.
9+
Se hai idee da proporre o suggerimenti, allora fai riferimento al [repository inglese](https://github.com/javascript-tutorial/en.javascript.info).
1010

11-
Hai trovato un errore? Manca un argomento? Createlo voi, e inviate un PR 👏
11+
Prima di iniziare ti segnalo che esiste anche un **[Canale Discord](https://discord.gg/Dj9P3jCt6K)** in cui potrai con gli altri contributors di quello che riguarda la traduzione e revisione degli articoli. O anche ricevere delle indicazioni su come inziare!
1212

13-
**Puoi modificare i file con un qualsiasi editor di testo.** Il tutorial sfrutta il formato "markdown", molto facile da utilizzare. Potete anche testare in tempo reale le modifiche, utilizzando il server locale presente a questo link <https://github.com/javascript-tutorial/server>.
13+
Se hai deciso di contribuire inanzitutto ti ringrazio per il supporto, e ti chiedo di leggere fino alla fine questo documento, in modo da velocizzare le revisioni e ridurre gli errori!
1414

15-
E' disponibile una lista di chi ha contribuito: <https://javascript.info/about#contributors>.
15+
## Indice
16+
- [Note importanti](#importante)
17+
- [Come contribuire](#come-contribuire)
18+
- [Consigli per la traduzione](#consigli-per-la-traduzione)
1619

17-
Un file inizia con `# Title Header`, e il testo è in formato Markdown, che può esserre modificato con un semplice editor di testo.
20+
## Importante
1821

19-
Eventuali risorse aggiuntive ed esempi utili per un articolo o esercizio, risiedono nella stessa cartella.
22+
- Quando effettui le traduzioni lavora **sempre** in un branch dedicato, in questo modo manteniamo il branch `master` il più pulito possibile. Continua a leggerer per maggiori informazioni.
2023

21-
## Consigli per la traduzione
24+
- Quando effettui le traduzioni fai sempre riferimento al [repository inglese](https://github.com/javascript-tutorial/en.javascript.info). Il tutorial è in costante aggiornameto, quindi gli articoli presenti in questo repository potrebbero non essere aggiornati all'ultima versione.
25+
26+
## Come contribuire
27+
28+
### 1. Visita la pagina con l'elenco degli articoli: [it.javascript.info](https://github.com/javascript-tutorial/it.javascript.info/issues/1)
29+
30+
Scorri la lista e scegli un articolo non ancora assegnato o tradotto. E' possibile riconsocere gli articoli già assegnati poichè riportano il nome del contributor:
31+
32+
```
33+
[ ] Generators (@mean2me) // articolo già assegnato
34+
[X] Generators (@mean2me) // articolo già tradotto
35+
```
36+
37+
### 2. Notifica l'articolo scelto
38+
39+
Prima di cominciare la traduzione ricordati di lasciare un commento con indicato il nome dell'articolo che desideri tradurre, in questo modo evitiamo che un articolo venga tradotto da più persone.
40+
41+
### 3. Esegui un fork del repository
42+
43+
Ora puoi iniziare con la traduzione! Per iniziare, devi eseguire un `fork` del repository!
44+
45+
### 4. Crea un branch dedicato
2246

23-
Se volete tradurre un articolo vi chiedo di seguire questi semplici passi:
47+
Una volta eseguito il `fork` ti chiedo di creare un branch separato su cui lavorare alla traduzione, in questo modo teniamo il ramo `master` pulito.
48+
Il nome del branch creato deve seguire il formato seguente:
2449

25-
- Leggete tra gli [issue](https://github.com/javascript-tutorial/it.javascript.info/issues) quello denominato "Translate Progress".
26-
- Scegliete l'articolo che desiderate tradurre e mettete la spunta.
27-
- Create un issue per informare il gestore della repository sull'articolo scelto.
28-
- Procedete con il fork della repository, traducete ed infine inviate una PR (Pull Request).
50+
```
51+
article/NomeArticolo
52+
```
2953

30-
Il vostro nome apparirà nella pagina "About project" quando la traduzione verrà pubblicata.
54+
### 5. Traduzione
3155

32-
<<<<<<< HEAD
33-
### Esempi ed Esercizi
34-
=======
35-
- `index.md` stands for a chapter
36-
- `article.md` stands for an article
37-
- `task.md` stands for a task (solution must be provided in `solution.md` file as well)
38-
>>>>>>> 872cc6adedac4ff3ebec73916bf435f1d72f2864
56+
**Importante**
57+
Per lavorare alla traduzione ti chiedo di prendere come riferimento l'articolo inglse, che puoi trovare al [seguente repository](https://github.com/javascript-tutorial/en.javascript.info).
58+
Il tutorial è in costante aggiornamento, quindi la versione inglese presente nel repository italiano potrebbe non essere aggioranta all'ultima versione!
3959

40-
- I commenti possono essere tradotti
41-
- Le variabili, classi o identificatori non devono essere assolutamente tradotte
42-
- Assicuratevi che il codice funzioni dopo averlo tradotto
60+
Se l'articolo contine esercizi, è necessaria anche la loro traduzione.
4361

44-
Esempio:
62+
### 6. Inoltra la traduzione
63+
64+
Una volta completata la traduzione è quasi fatta, rimangono ancora un paio di cose da fare:
65+
66+
1. Effettua un rapido controllo ortografico. Puoi farlo utilizzando un qualsiasi tool online gratuito, ad esempio [Language Tool](https://languagetool.org/).
67+
68+
2. Inoltra un `Pull Request` al branch `master` del repository.
69+
70+
3. (Opzionale) Notifica il completamento della traduzione tramite il **[Canale Discord](https://discord.gg/Dj9P3jCt6K)** in modo da rendere più rapide le revisioni.
71+
72+
### 7. Tieni monitorata la PR
73+
74+
Tieni monitorata la Pull Request in caso ti venga richiesto di apportare delle modifiche.
75+
A questo punto, in attesa di approvazione, puoi prendere in carico la traduzione di un altro articolo.
76+
77+
78+
# Grazie per la collaborazione 😍
79+
80+
## Consigli per la traduzione
81+
Lascio un elenco rapido da consultare durante la traduzione per mantenere la guida più conforme possibile.
4582

46-
```js
47-
// Example
48-
const text = "Hello, world";
49-
document.querySelector('.hello').innerHTML = text;
50-
```
83+
Cosa tradurre:
84+
- Tradurre l'articolo nella sua interezza, compresi i task e le solution
85+
- Tradurre anche i commenti negli esempi all'interno degli articoli
5186

52-
✅ GIUSTO (traduzione commento):
87+
Cosa **non** tradurre:
88+
- Non è necessario tradurre gli esempi, è sufficiente la traduzione dei commenti. Quindi il contenuto delgi alert, nomi delle funzioni/classi deve rimanere in lingua inglese.
5389

54-
```js
55-
// Esempio
56-
const text = 'Ciao mondo';
57-
document.querySelector('.hello').innerHTML = text;
58-
```
90+
```
91+
function sayHello() {
92+
alert("Hello, World!") // show the text 'Hello, World!'
93+
}
94+
```
5995

60-
❌ SBAGLIATO (traduzione classi):
96+
verrà tradotto come segue:
6197

62-
```js
63-
// Esempio
64-
const testo = 'Ciao mondo';
65-
// ".hello" è una classe
66-
// NON TRADURLO
67-
document.querySelector('.ciao').innerHTML = text;
68-
```
98+
```
99+
function sayHello() {
100+
alert("Hello, World!") // mostra il testo 'Hello, World!'
101+
}
102+
```
69103

70-
### Link esterni
104+
- Non è necessario tradurre le immagini utilizzate durante le spiegazioni
71105

72-
Se trovate dei link esterni verso Wikipedia, esempio `https://en.wikipedia.org/wiki/JavaScript`, ed esiste la versione italiana, accertatevi che questa sia di qualità prima di cambiare il link.
106+
Alcuni termini ricorrenti:
107+
- Nomi dei tipi vanno mantenuti in inglese:
73108

74-
Esempio:
109+
**Date is a JavaScript data type.**
75110

76-
```md
77-
[JavaScript](https://en.wikipedia.org/wiki/JavaScript) is a programming language.
78-
```
111+
Verrà tradotto come:
112+
113+
✅ Date è un tipo di dato in JavaScript.
79114

80-
✅ OK (en -> it):
115+
❌ Data è un tipo di dato in JavaScript.
116+
117+
- **Summary**, il termine che trovere a fine di ogni articolo va tradotto come **Riepilogo**
81118

82-
```md
83-
[JavaScript](https://it.wikipedia.org/wiki/JavaScript) è un linguaggio di programmazione.
84-
```
119+
### FAQ
85120

86-
Per i link verso MDN, che sono tradotti solo parzialmente, conviene utilizzare quelli originali.
121+
<details>
122+
<summary>In quale formato sono scritti gli articoli?</summary>
87123

88-
Se un articolo linkato non possiede una versione italiana, allora mantenete quello originale.
124+
Il tutorial segue lo standard testuale "Markdonw", è molto semplice da utilizzare. In ogni caso non vi è richiesto di mettere mano al formato, è sufficiente la traduzione del testo.
125+
</details>
89126

90-
### Glossario dei termini
127+
<details>
128+
<summary>Cosa posso utilizzare per tradurre gli articoli?</summary>
91129

92-
Alcuni termini utilizzati spesso:
130+
Puoi tradurre gli articoli utilizzando il tool con cui ti tovi più comodo. Puoi farlo direttamente con l'editor di testo intergato di GitHub se ti trovi più a tuo agio.
93131

94-
- 'Summary' viene tradotto con 'Riepilogo'
95-
- Il nome dei tipi come: 'primitives', 'string', 'object' viene tradotto ('primitivi', 'stringhe', 'oggetto') mantenendo tra parentesi la versione in lingua originale
132+
L'importante è rispettare le linee guida fornite sopra!
133+
</details>
96134

97135
---
98136
♥

0 commit comments

Comments
 (0)