Contributing

Vuoi aggiungere una guida al Marconi Wiki?

Perfetto.
Significa che:

1. Hai capito qualcosa
2. Hai tempo
3. Hai deciso di usarlo bene

Rispetto. Aura.

Come funziona tecnicamente?

Il sito è:

• scritto in Markdown
• costruito con VitePress
• hostato su GitHub
• pubblicato tramite GitHub Pages

Questo significa che per contribuire devi usare GitHub. Qualsiasi metodo decidi di usare, creati un account prima di iniziare.

Non venite a dire che Markdown o GitHub è troppo difficile. Siamo un tecnico, non il Fermi.

Metodo 1 - Facile

Non serve installare nulla.

1. Vai nella repository GitHub del progetto
2. Fai Fork
3. Crea una nuova pagina .md nella cartella corretta
4. Scrivi la tua guida in Markdown
5. Fai una Pull Request

Fine.

Se la guida è valida, viene approvata.
Se c'è qualcosa da sistemare, ti verranno suggerite modifiche.

Metodo 2 — Difficile

(con difficile s'intende che sai usare git)

1. Fork della repo
2. git clone
3. Crea un branch
4. Aggiungi la tua pagina
5. Commit decente
6. Push
7. PR

Se fai squash con 19 commit chiamati asd, piango.

Linee guida per scrivere una buona guida

Prima di aprire la PR chiediti:

• Questa pagina aiuta davvero qualcuno?
• È chiara?
• È strutturata bene?
• Ha esempi?
• È leggibile prima di una verifica?

Evita:

• Muri di testo infiniti
• Definizioni copiate dal libro
• Spiegazioni vaghe
• Meme a caso (uno ogni tanto va bene, 47 no)

Posso usare ChatGPT?

Sì, ma:

• non deve scrivere al posto tuo
• deve aiutarti a chiarire, non a generare lore
• se non capisci quello che c'è scritto, non pubblicarlo

Puoi usarlo per correggere errori grammaticali, sistemare la struttura o aiutarti con il Markdown. Proprio come... tutto questo sito.

La regola è facile:
Se il prof ti interrogasse sulla tua stessa guida, sapresti spiegarla?

Se la risposta è no, riscrivi.