Skip to content

Commit 6247879

Browse files
authored
Merge pull request #185 from longo-andrea/feature/readme
update README
2 parents 97f75eb + 479ac18 commit 6247879

File tree

1 file changed

+19
-74
lines changed

1 file changed

+19
-74
lines changed

README.md

Lines changed: 19 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ Ci piacerebbe ricevere il tuo contributo nella traduzione e/o revisione degli ar
88

99
Se hai idee da proporre o suggerimenti, allora fai riferimento al [repository inglese](https://github.com/javascript-tutorial/en.javascript.info).
1010

11-
Prima di iniziare ti segnalo che esiste anche un **[Canale Discord](https://discord.gg/Dj9P3jCt6K)** in cui potrai parlare con gli altri contributors di quello che riguarda la traduzione e revisione degli articoli. O anche ricevere delle indicazioni su come iniziare!
11+
Prima di iniziare ti segnalo che esiste anche un **[Canale Discord](https://discord.gg/Dj9P3jCt6K)** in cui potrai parlare con gli altri contributors di quello che riguarda la traduzione e revisione degli articoli. O anche ricevere delle indicazioni su come iniziare! Non è assolutamente obbligatorio accedere al server per lavorare alle traduzioni, le informazioni necessarie sono tutte repereibili in questo repository.
1212

13-
Se hai deciso di contribuire innanzitutto 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!
13+
Se hai deciso di contribuire innanzitutto 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, ci vorranno meno di 5 minuti!
1414

1515
## Indice
1616
- [Note importanti](#importante)
@@ -25,70 +25,19 @@ Se hai deciso di contribuire innanzitutto ti ringrazio per il supporto, e ti chi
2525

2626
## Come contribuire
2727

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 riconoscere 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 è importante lasciare un commento all'interno della issue [Italian Translation Progress](https://github.com/javascript-tutorial/it.javascript.info/issues/1)
40-
Il commento deve contenere solo il titolo dell'articolo che volete tradurre, in questo modo l'articolo vi viene assegnato e si evita che un articolo venga tradotto da più persone.
41-
42-
### 3. Esegui un fork del repository
43-
44-
Ora puoi iniziare con la traduzione! Per iniziare, devi eseguire un `fork` del repository!
45-
46-
### 4. Crea un branch dedicato
47-
48-
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.
49-
Il nome del branch creato deve seguire il formato seguente:
50-
51-
```
52-
article/NomeArticolo
53-
```
54-
55-
### 5. Traduzione
56-
57-
**Puoi lavorare con qualsiasi editor di testo.** Il tutorial è scritto utilizzando una versione migliorata del linguaggio markdown, facile da utilizzare. Se vuoi avere una preview del tuo lavoro di traduzione, puoi installare localmente questo [server](https://github.com/javascript-tutorial/server).
58-
59-
**Importante**
60-
Per lavorare alla traduzione ti chiedo di prendere come riferimento l'articolo inglese, che puoi trovare al [seguente repository](https://github.com/javascript-tutorial/en.javascript.info).
61-
Il tutorial è in costante aggiornamento, quindi la versione inglese presente nel repository italiano potrebbe non essere aggiornata all'ultima versione!
62-
63-
Se l'articolo contiene esercizi, è necessaria anche la loro traduzione.
64-
65-
### 6. Inoltra la traduzione
66-
67-
Una volta completata la traduzione è quasi fatta, rimangono ancora un paio di cose da fare:
68-
69-
1. Effettua un rapido controllo ortografico. Puoi farlo utilizzando un qualsiasi tool online gratuito, ad esempio [Language Tool](https://languagetool.org/).
70-
71-
2. Inoltra un `Pull Request` al branch `master` del repository.
72-
73-
3. (Opzionale) Notifica il completamento della traduzione tramite il **[Canale Discord](https://discord.gg/Dj9P3jCt6K)** in modo da rendere più rapide le revisioni.
74-
75-
### 7. Tieni monitorata la PR
76-
77-
Tieni monitorata la Pull Request in caso ti venga richiesto di apportare delle modifiche.
78-
A questo punto, in attesa di approvazione, puoi prendere in carico la traduzione di un altro articolo.
79-
80-
81-
# Grazie per la collaborazione 😍
28+
Ti chiedo di leggere rapidamente anche il documento [CONTRIBUTING.MD](https://github.com/javascript-tutorial/it.javascript.info/blob/master/CONTRIBUTING.md), in cui potrai trovare tutte le informazioni sul modo migliore per collaborare al respository!
8229

8330
## Consigli per la traduzione
84-
Lascio un elenco rapido da consultare durante la traduzione per mantenere la guida più conforme possibile.
8531

86-
Cosa tradurre:
87-
- Tradurre l'articolo nella sua interezza, compresi i task e le solution
32+
Durante la traduzione tenete sempre sotto mano il [Glossario](https://github.com/javascript-tutorial/it.javascript.info/issues/167).
33+
Questo vi sarà utile in fase di traduzione nel caso in cu incontraste una parola che non sapete se o come tradurre. Esempio il termine `debugger` viene mantenuto tale anche in italiano, in quanto di uso comune nell'ambito dello sviluppo software. Nel caso in cui la parola non sia presente nel glossario, potete richiedere consiglio lasciando un commento.
34+
35+
Altre cose utili da tenere a mente in fase di traduzione:
36+
- Tradurre l'articolo nella sua interezza, compresi i task e le solutions
8837
- Tradurre anche i commenti negli esempi all'interno degli articoli
8938

9039
Cosa **non** tradurre:
91-
- Non è necessario tradurre gli esempi, è sufficiente la traduzione dei commenti. Quindi il contenuto degli alert, console.log, nomi delle funzioni/classi deve rimanere in lingua inglese.
40+
- Non è necessario tradurre il codice degli esempi, è sufficiente la traduzione dei commenti. Quindi il contenuto degli alert, console.log, nomi delle funzioni/classi deve rimanere in lingua inglese.
9241

9342
```
9443
function sayHello() {
@@ -108,25 +57,12 @@ Cosa **non** tradurre:
10857

10958
- All'interno dei files degli esercizi `task.md` la voce iniziale `importance:` non va tradotta
11059

111-
Alcuni termini ricorrenti:
112-
- Nomi dei tipi vanno mantenuti in inglese:
113-
114-
**Date is a JavaScript data type.**
115-
116-
Verrà tradotto come:
117-
118-
✅ Date è un tipo di dato in JavaScript.
119-
120-
❌ Data è un tipo di dato in JavaScript.
121-
122-
- **Summary**, il termine che troverete a fine di ogni articolo va tradotto come **Riepilogo**
123-
12460
### FAQ
12561

12662
<details>
12763
<summary>In quale formato sono scritti gli articoli?</summary>
12864

129-
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.
65+
Il tutorial segue lo standard testuale "Markdown", è molto semplice da utilizzare. In ogni caso non vi è richiesto di mettere mano al formato, è sufficiente la traduzione del testo.
13066
</details>
13167

13268
<details>
@@ -137,6 +73,15 @@ Alcuni termini ricorrenti:
13773
L'importante è rispettare le linee guida fornite sopra!
13874
</details>
13975

76+
<details>
77+
<summary>Posso tradurre un solo paragrafo?</summary>
78+
79+
No, l'articolo va tradotto nella sua interezza.
80+
</details>
81+
82+
---
83+
# Grazie per la collaborazione 😍
84+
14085
---
14186
14287
Ilya Kantor @iliakan

0 commit comments

Comments
 (0)