Guide ai progetti

Modello CONTRIBUTING.md per un repository open source

Un file CONTRIBUTING.md aiuta a passare da “voglio aiutare” a una issue o pull request utile. Spiega il più piccolo contributo supportato e come verificarlo. I requisiti dovrebbero riflettere il funzionamento reale del progetto, non un processo ambizioso che nessuno segue.

Redazione di GitHubStart · Aggiornato

Copia e adatta il modello di contribuzione

Sostituisci i segnaposto e verifica ogni comando e link. Continua ad accogliere correzioni alla documentazione e segnalazioni di bug anche quando un collaboratore non è pronto a modificare il codice dell’applicazione.

# Contribuire

## Prima di iniziare
Leggi il README e controlla le issue esistenti.
Per modifiche importanti, discuti l’approccio prima di implementarlo.

## Configurazione locale
[Ambiente di esecuzione richiesto e comandi di configurazione verificati]

## Segnalare un bug
Includi versione, ambiente, passaggi, risultato atteso e risultato effettivo.
Rimuovi segreti e dati personali dai log.

## Inviare una pull request
- Spiega il problema e la modifica proposta.
- Mantieni la modifica mirata.
- Esegui [i controlli specifici del progetto].
- Aggiorna la documentazione interessata.

## Revisione
[Chi revisiona, come rispondere e disponibilità realistiche]

## Altri modi per aiutare
[Documentazione, esempi, traduzioni o segnalazioni riproducibili]

Rendi le linee guida facili da trovare

GitHub riconosce le linee guida per contribuire nella radice del repository e nelle directory docs o .github. Collega il file anche dal README, così chi legge l’introduzione del progetto può trovare subito il processo.

Rivedi il percorso dai punti di ingresso reali per contribuire al repository. Se esistono più file di linee guida, armonizza le istruzioni in conflitto. Un collaboratore non dovrebbe trovare un comando di configurazione nel README e un altro diverso e non supportato nella guida ai contributi.

Progetta un primo contributo accessibile

Scegli un piccolo compito dal risultato chiaro, come correggere un esempio per un ambiente di esecuzione supportato. Spiega come riprodurre il problema, quale comportamento deve cambiare e come verificarne il completamento. Evita di definire un compito adatto ai principianti se dipende da conoscenze interne non documentate.

Dichiara onestamente la tua disponibilità per le revisioni. Se non puoi promettere un tempo di risposta, spiega invece come i collaboratori possono controllare lo stato. Confini chiari riducono il lavoro abbandonato e sono più utili della promessa di integrare ogni contributo.

Domande frequenti

CONTRIBUTING.md sostituisce README.md?

No. Il README spiega il progetto e come usarlo. Le linee guida per contribuire spiegano come proporre e verificare modifiche.

Dovrei copiare i comandi di test di un altro progetto?

Solo se sono anche i comandi corretti per il tuo progetto. Sostituisci i segnaposto con comandi che hai effettivamente verificato.

Le linee guida per contribuire garantiscono più collaboratori?

No. Riducono l’incertezza per le persone interessate, ma l’utilità del progetto, la qualità dei compiti e il seguito dei manutentori restano importanti.

Riferimenti