Skip to content

Commit b12695b

Browse files
authored
Merge pull request #164 from pasor1/improve-contributing
Improve contributing.md
2 parents 211fb79 + d43d944 commit b12695b

File tree

1 file changed

+36
-13
lines changed

1 file changed

+36
-13
lines changed

CONTRIBUTING.md

Lines changed: 36 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,50 @@
11
# The Modern JavaScript tutorial in Italiano
2-
Ciao a tutti! Questa è la traduzione italiana del tutorial [The Modern JavaScript Tutorial
3-
](https://javascript.info/).
2+
Ciao a tutti! Questa è la traduzione italiana del tutorial [The Modern JavaScript Tutorial](https://javascript.info/).
43

5-
Se volete contribuire alla traduzione del tutorial, inanzitutto date un'occhiaata al [README.md](./README.md) per maggiori dettagli.
4+
Tutti possono contribuire, ed ogni contributo è ben accetto. Partecipare al progetto è facile, basta conosce l'inglese e seguire le poche linee guida che trovate in questo documento.
65

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.
6+
Se hai poca dimestichezza con GitHub non preoccuparti: di seguito trovi una utile guida che ti aiuterà a partire. E se non conosci benissimo JavaScript, nessun problema, puoi partecipare rivedendo e/o correggendo articoli che trattano argomenti semplici. Sarà anche occasione per apprendere e migliorare le tue competenze su questo linguaggio.
7+
8+
Per una coordinazione più rapida ed informale abbiamo creato un canale Discord, a cui puoi unirti per discutere di qualsiasi cosa riguardante la traduzione o anche solo per chiedere informazioni su come iniziare.
89

910
- **[Canale Discord](https://discord.gg/Dj9P3jCt6K)**
1011

1112
## 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
1513

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.
14+
Il tutorial è scritto utilizzando una versione migliorata del linguaggio **[markdown](https://guides.github.com/features/mastering-markdown/)**, facile da comprendere ed utilizzare.
15+
16+
Sebbene si possa iniziare a tradurre online, direttamente su GitHub (questa modalità è più indicata per le piccole correzioni che per la traduzione di interi articoli), ti consigliamo di lavorare in locale utilizzando il tuo editor di testo preferito, servendoti anche di uno strumento per il controllo ortografico (molti editor li hanno come plugins o estensioni), questo faciliterà il tuo lavoro di traduzione e quello di approvazione dei reviewers.
17+
18+
Il flusso di lavoro è abbastanza semplice e presuppone alcune piccole accortezze che ci aiuteranno ad automatizzare e facilitare la progressione.
19+
20+
Per prima cosa trova come puoi renderti utile al progetto:
21+
22+
- **Tradurre un articolo non ancora tradotto**: Leggi la issue [Italian Translation Progress](https://github.com/javascript-tutorial/it.javascript.info/issues/1) e trova, tra gli articoli non ancora spuntati, quello che vorresti tradurre. Quindi **rispondi alla issue con un messaggio contenete il solo titolo dell'articolo** scelto. In questo modo il [bot](https://javascript.info/translate/bot) che aiuta i team di traduzione ti affiderà il lavoro.
23+
24+
- **Revisionare un articolo già tradotto**: Alcuni articolo tradotti tempo fa hanno bisogno di essere rivisti, corretti o aggiornati. Vai alla issue [Revisione articoli passati](https://github.com/javascript-tutorial/it.javascript.info/issues/119), qui potrai scegliere dalla lista l'articolo che vuoi revisionare. Notifica la tua scelta con un messaggio nella issue ed i maintainers si occuperanno di assegnarti la traduzione. In questo caso è importante confrontare l'articolo con la controparte in inglese per controllare se ci sono state aggiunte o correzioni, ed eventualmente riportarle nella revisione.
1725

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...
26+
- **Correzione errori**: Se hai notato un errore nei testi già tradotti, comunicalo con una nuova issue. Ci occuperemo di correggerlo, o, se vorrai, ti spiegheremo come potrai correggerlo tu stesso.
1927

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.
28+
Una volta che avrai scelto cosa fare ed i maintainers ti avranno assegnato l'articolo, potrai iniziare. Se hai già collaborato a qualche progetto opensource su GitHub non avrai difficoltà, se invece sei nuovo, abbiamo preparato una piccola [guida](#sei-nuovo-su-github?) che trovi più in basso.
2129

22-
- [Language Tool](https://languagetool.org/)
30+
Se vuoi avere una preview dei file che stai editando, puoi usare una versione locale del server che si occupa della pubblicazione online del tutorial: [javascript.info server](https://github.com/javascript-tutorial/server). Sulla repository trovi le istruzioni per l'installazione ed il funzionamento.
31+
32+
Quando avrai terminato la traduzione, invia una pull request usando come titolo il titolo dell'articolo tradotto, quindi monitora la review nel caso ti venga chiesto di apportare qualche modifica o correzione.
33+
## Sei nuovo su GitHub?
34+
35+
Tutto il progetto è ospitato da GitHub. La seguente guida presuppone che tu conosca le basi di git (add, commit, ecc...) e ti aiuterà a capire il flusso di lavoro su GitHub.
36+
37+
1. Esegui un `fork` di questo repository cliccando sul tasto in alto a destra nell'interfaccia di GitHub. In questo modo avrai una tua versione del progetto sulla quale potrai lavorare senza temere di fare pasticci.
38+
39+
2. Fai un [`clone`](https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/cloning-a-repository) del tuo fork `git clone url-del-fork-personale.git`. Bene ora hai la tua copia locale della repository sulla quale potrai iniziare a lavorare.
40+
41+
3. Dopo che ti verrà assegnato un articolo da tradurre/correggere/revisionare (vedi più avanti come), procedi creando in locale un nuovo `branch`. **E' importante lavorare sempre su un branch secondario, mai su quello principale (master o main)**. Per creare un nuovo branch puoi digitare il comando `git checkout -b nome-del-nuovo-branch`. Per convenzione, come nome del nuovo branch, usa il formato `article/nome-del-file-da-tradurre`.
42+
Prima di iniziare a modificare i files, assicurati sempre di trovarti nel branch di lavoro `git checkout nome-del-nuovo-branch`. Ora puoi iniziare a tradurre: lavora bene, con attenzione e dacci dentro :muscle:
43+
44+
4. Una volta terminato il lavoro, è il momento di inviarlo tramite una `pull request` affinché venga approvato ed incluso nel progetto originale (`merge`). **Come titolo della PR inserisci il titolo dell'articolo che stai traducendo**, lo trovi nella issue [Italian Translation Progress](https://github.com/javascript-tutorial/it.javascript.info/issues/1).
2345

24-
5. Una volta terminata la traduzione inoltra una `Pull Request` sul branch `master`.
46+
5. Da questo momento il tuo articolo si troverà in fase di revisione (`review`) da parte dei maintainers, i quali potrebbero chiederti di correggere o migliorare qualche cosa. Tieni monitorata la tua pull request, così potrai interagire durante la fase di review e procedere speditamente verso l'approvazione.
2547

26-
6. (Opzionale) Informa i maintainer della tua PR tramite il canale Discord in modo da velocizzare la presa in carico.
48+
6. Se tutto è andato per il verso giusto, il tuo lavoro verrà approvato ed incorporato nel progetto ... ora puoi festeggiare :tada: :tada: :tada:
2749

50+
7. Se hai intenzione di continuare a collaborare, ti sarà utile mantenere le tue repositories sincronizzate col lavoro di traduzione in corso. Per farlo ti consigliamo di aggiungere la repository originale come nuovo remote `git remote add upstream https://github.com/javascript-tutorial/it.javascript.info.git`, ed eseguire il comando `git pull upstream master && git push origin master` tutte le volte prima di iniziare un nuovo lavoro di traduzione o correzione.

0 commit comments

Comments
 (0)