Come Contribuire

I contenuti del Glossario Cloud Native sono disponibili in questo repository di GitHub, dove troverai una lista di issue, PR, e discussion riguardanti il glossario.

Ci sono quattro modi in cui puoi contribuire:

1. Risolvere una issue aperta
2. Proporre nuove voci
3. Migliorare quelle esistenti
4. Aiutare nella traduzione del glossario

Chi può contribuire?

L’obiettivo di questo Glossario è di rendere il contesto cloud native - noto a tutti per la sua complessità - più fruibile e facile da comprendere. Pertanto il nostro impegno è verso la semplicità.

Spiegare concetti complessi in parole semplici è di per sé veramente difficile. E sebbene un prodotto finale alla portata di tutti possa sembrare facile da ottenere, raggiungere il livello di semplicità prefissato è il risultato di duro lavoro e collaborazione tra esperti del mondo nativo cloud. In sintesi, per contribuire alla scrittura di nuovi termini, c’è bisogno di una profonda conoscenza dell’argomento.

Per la traduzione dei contenuti il discorso è diverso. Data una solida definizione in inglese, si possono creare termini ben tradotti anche se si ha meno esperienza sul tema. Questo aspetto del progetto è più a misura di principiante.

Entra nella Glossary community

Valuta di entrare anche tu nei nostri meeting mensili del Glossary Working Group, se hai intenzione di contribuire regolarmente. Puoi trovare i dettagli del meeting nel calendario della CNCF. Puoi anche connetterti con i gestori e i contributors nel nostro canale #glossary-localizations della CNCF Slack — ti aspettiamo!

Risolvere una issue aperta

Vai nella sezione issues nel repo del Glossario su GitHub. Lì troverai una lista di issues. Puoi filtrarle per label (come ad esempio “English language”, “help needed”, “good first issue”). NB: Hai bisogno di un account Github!

Assicurati che il termine di tuo interesse non sia già stato assegnato ad altri. Di seguito puoi notare che le prime tre voci sono da assegnare, mentre la successiva è stata assegnata a qualcuno.

Una volta trovato il termine a cui vuoi lavorare, scrivilo nella issue. Ti basta cliccare e aggiungere un commento.

Quindi considera anche di unirti al canale #glossary nello Slack del CNCF e di informare i maintainers che ti sei assegnato un nuovo termine (idealmente dovresti menzionare @Catherine Paganini, @jmo, @Seokho Son, @Jihoon Seo, and/or @iamnoah per essere sicuro che ricevano il messaggio). Ricorda: puoi solo assegnarti un termine per volta. Se vuoi lavorare su più termini, finiscine uno prima di assegnartene un altro.

Una volta assegnato a te, puoi iniziare a lavorarci. Per gli step successivi, fai riferimento alla sezione Proporre un nuovo termine (creare una PR).

Proporre nuove voci

Puoi sia proporre nuove voci su cui altri possono lavorare, o crearne tu stesso anche la definizione. In entrambi i casi dovrai iniziare aprendo una issue. Considera sempre che i termini devono aderire alla definizione di cloud native secondo il CNCF. le sole eccezioni sono i termini fondamentali a supporto della comprensione dei concetti cloud native.

Di seguito trovi una guida che ti spiegherà passo dopo passo come fare, se non hai ancora dimestichezza con Github. Se invece sei un GitHub Pro, assicurati di scorrere la lista degli issue prima, di usare il template corretto e una naming convention appropriata, e di segnalare la tua PR su Slack (altrimenti potremmo non notarla) assieme alla posizione del template del file. Infine, assicurati di leggere la Guida di Stile prima di iniziare — grazie!

Creare una issue

Apri le issues nel repo del Glossario su GitHub and clicca su “new issue”.

Qui sono presenti diversi template. Per proporre un nuovo termine in inglese, seleziona “English Language Glossary Request”.

Aggiungi la parola che vuoi suggerire, rispondi alle due domande di seguito, contrassegna le checkbox e clicca su “Submit new issue”. Se stai solo proponendo un nuovo termine, hai già finito! Se invece intendi lavorare sulla sua definizione, prosegui con i prossimi step.

Triaging your issue

A questo punto i maintainers valuteranno la issue, e stabiliranno se il termine potrà far parte del Glossario (non tutti i termini saranno ammessi, ma soltanto quelli riconosciuti e largamente diffusi nell’ambito cloud native).

Per favore informa i maintainers su Slack che hai inserito la richiesta di un nuovo termine, altrimenti potrebbero non notarla. Idealmente dovresti menzionare @Catherine Paganini, @jmo, @Seokho Son, @Jihoon Seo, and/or @iamnoah. Se il termine è approvato e hai espresso la volontà di lavorarci su, lo assegneranno a te.

Nota che puoi lavorare su un termine alla volta. Se vuoi lavorare su più termini, ti chiediamo di finirne uno prima di richiedere di essere assegnato al successivo.

Proporre un nuovo termine (creare una PR)

Prima di iniziare, per favore leggi la Guida di Stile — aiuterà a minimizzare gli errori più comuni in fase di revisione. Ti consigliamo caldamente di iniziare da un Word o da un Google doc.

Una volta che il termine è pronto per essere pubblicato, vai alla cartella content del codice…

…quindi nel folder “en” (o della cartella che riporta la sigla della lingua per cui stai proponendo il termine)…

…quindi seleziona il file _TEMPLATE.md

Copiane il contenuto…

…e ritorna nella cartella “en”. Clicca su “add file” e seleziona “create new file”.

Aggiungi il nome del termine nell’URL (senza caratteri maiuscoli, né spazi, né parentesi, e con l’uso del trattino per separare le parole) e .md alla fine (se la preview di Github non funziona, è probabile tu abbia dimenticato di aggiungere .md). Ora aggiungi il contenuto del template. Copia e incolla la definizione del termine nel file. Per agevolare la review, per favore usa interruzioni di riga semantiche (vale a dire: una riga per ogni frase). Nota che GitHub usa il markdown per formattare il testo (ad esempio per identificare un link o un testo in grassetto o in corsivo). Fai riferimento a questo schema per saperne di più:markdown cheat sheet. Per visualizzare la pagina in anteprima, vai alla “preview”.

Scorri la pagina in basso e dai un titolo al commit quando sei pronto per la pubblicazione. In questo momento stai effettuando il commit del termine nel tuo branch. Per creare una PR manca ancora un passaggio. Clicca su “commit new file” e…

…ora puoi creare una PR:

Ora dovresti vedere la tua PR tra le “Pull requests”.

Modifica un termine esistente

Per modificare un termine esistente, puoi decidere di proporre una modifica tramite una issue o modificare direttamente il termine e creare una pull request (PR).

Richiedere una modifica tramite una issue

Se vuoi riportare un problema con un termine ma non puoi/vuoi risolverlo da solo, clicca su “report issue”

Aprirai così una issue. Riporta nella descrizione che tipo di modifica bisogna apportare, e la motivazione. Una volta cliccato su submit, hai finito .

Aggiornare un termine direttamente

Per aggiornare direttamente il termine, vai su “edit this page.”

ti si aprirà la pagina di Github relativa al termine. Fai le tue modifiche e apri una PR. Fai riferimento al paragrafo Proporre un nuovo termine per una descrizione dettagliata di come modificare un file markdown.

Aiutaci a tradurre il Glossario

Per aiutare a tradurre il Glossario nella tua lingua madre, entra nel canale #glossary-localizations della CNCF Slack e faccelo sapere. Puoi entrare a far parte di un team già esistente o crearne uno nuovo. (per vedere cosa comporta, leggi la nostra Guida alla Localizzazione). Puoi anche partecipare al nostro meeting del Glossary Working Group. Trovi tutte le informazioni per il meeting nel calendario della CNCF. Ti aspettiamo!