Prima di tutto - GRAZIE per aver trovato il tempo di contribuire! 🌋👍
Questo sito web è costruito utilizzando Docusaurus 2, tutte le vostre modifiche si rifletteranno su Lava Docs @ docs.lavanet.xyz
- Segnala un problema o un errore riscontrato
- Suggerite una correzione tramite PR (leggete sotto)
- Vuoi aggiungere nuovi contenuti/tutorial? Proponetelo prima tramite un nuovo problema e solo dopo scrivetelo, per risparmiare tempo.
In questa guida avrete una panoramica del flusso di lavoro dei contributi, dall'apertura di un problema, alla creazione di una PR, alla revisione e all'unione della PR.
Per avere una visione d'insieme di Lava, leggere la Docs Intro.
Questo repository è in linea con le migliori pratiche di contribuzione all'open source che si trovano in molti repository su GitHub. Se non le conoscete, iniziate da queste ottime risorse:
- Trovare modi per contribuire all'open source su GitHub
- Configurare Git
- Flusso di GitHub
- Collaborare con le richieste di pull
Lava docs serve diversi tipi di utenti in diverse fasi del ciclo di vita. Vogliamo creare una risorsa di documenti che si adatti a tutti, ma che abbia un denominatore comune di stile.
Le guide di stile sono una guida e non una restrizione; i buoni articoli che abbiamo scelto per questo scopo sono:
- Quando si tratta di opeartizioni git, raccomandiamo https://cbea.ms/git-commit/.
- Quando si tratta del contenuto vero e proprio dei documenti, raccomandiamo https://medium.com/larimaza-en/how-to-write-good-documentation-e19c70dc67f0
Se si riscontra un problema nella documentazione, cercare se esiste già un problema. Se non esiste un problema correlato, si può aprire un nuovo problema usando un apposito modulo per i problemi.
Scorrete i nostri problemi esistenti per trovarne uno che vi interessa. È possibile restringere la ricerca utilizzando i labels come filtri. Se si trova un problema su cui lavorare, si può aprire una PR con una soluzione.
Fare clic su Porta un contributo in fondo a qualsiasi pagina del documento per apportare piccole modifiche, come un errore di battitura, la correzione di una frase o un link interrotto. Si accede al file `.md' dove si possono apportare le modifiche e creare una richiesta di pull per la revisione.
- Installare Git
- Aprire il repository
- Clonarlo nel proprio spazio di lavoro
- Eseguire una versione locale usando
$ yarn start. - Create un ramo di lavoro e iniziate con le vostre modifiche!
Effettuare il commit delle modifiche una volta che si è soddisfatti.
Una volta terminate le modifiche, creare una richiesta di pull, nota anche come PR.
- Compilare il modello "Ready for review" (pronto per la revisione), in modo che la PR possa essere revisionata. Questo modello aiuta i revisori a capire le modifiche e lo scopo della richiesta di pull.
- Non dimenticare di collegare la PR al problema se ne stai risolvendo uno.
- Attivare la casella di controllo allow maintainer edits, in modo che il ramo possa essere aggiornato per un merge. Una volta inviata la PR, un membro del team esaminerà la proposta. Potremmo fare domande o richiedere informazioni aggiuntive.
- Potremmo chiedere di apportare delle modifiche prima che la PR possa essere unita, usando suggested changes o i commenti alla richiesta di pull. È possibile applicare le modifiche suggerite direttamente attraverso l'interfaccia utente. È possibile apportare qualsiasi altra modifica nel proprio fork, quindi eseguire il commit nel proprio ramo.
- Quando si aggiorna la PR e si applicano le modifiche, contrassegnare ogni conversazione come risolta.
- Se si incontrano problemi di fusione, consultare questo tutorial git per risolvere conflitti di fusione e altri problemi.
Congratulazioni 🦸 Lava ti ringrazia 🌋🙏.
Una volta che il tuo PR è stato unito, i tuoi contributi saranno visibili pubblicamente su Lava Docs.
Grazie a GitHub Docs per l'ispirazione nella stesura del testo di questo contributo.