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 tre modi in cui puoi contribuire:
- Proporre nuove voci
- Migliorare quelle esistenti
- Aiutare nella traduzione del glossario
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!
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 (avrai bisogno di un account di Github per farlo).
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 e usare il template corretto, una naming convention appropriata e segnalare la tua PR su Slack (altrimenti potremmo non notarla). 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 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.
Entra nel canale #glossary dello Slack CNCF e contatta @Catherine Paganini, @jmo e @Seokho Son, informandoli che hai creato una issue e che vuoi lavorarla. Ti assegneranno la issue, segnalando agli altri che il termine è già stato preso in carico.
Di seguito puoi notare che le prime tre voci sono da assegnare, mentre la successiva è stata assegnata a qualcuno.
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) 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.
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 dovesti 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. Puoi anche partecipare al nostro meeting del Glossary Working Group. Trovi tutte le informazioni per il meeting nel calendario della CNCF. Ti aspettiamo!