Hey principianti,
Complimenti per rendere il vostro modo di open source. È una grande comunità.
È un po ‘ confuso all’inizio. Come contribuire, dove contribuire, problemi, bug, PR, PR, PR!
Non preoccuparti, mentre ti coinvolgi nell’open source imparerai tutto.
Ma oggi vorrei dare a tutti voi qualche consiglio che non ho mai ricevuto quando ho iniziato il mio viaggio open source.
Ho iniziato a contribuire all’open source e a mettere tutti i miei piccoli progetti collaterali su GitHub qualche tempo fa., Allora non sapevo della parte README. Il tempo passò e ho iniziato a seguire alcuni sviluppatori kickass. Senza dubbio tutti avevano progetti incredibili, ma la cosa più comune era, tutti i loro progetti avevano README impressionante ed è così che sono venuto a sapere l’importanza di un buon README.
FERMATI!! Non mi interessa leggere il tuo viaggio open source. Dimmi solo come scrivere un buon README.
Figo. Quindi eccoti qui –
Prima di iniziare a mettere i tuoi fantastici progetti su GitHub, voglio che tu vada a leggere prima lo sviluppo guidato da Readme.,
Perché dovrei preoccuparmi di un README?
La comunità open source sta crescendo rapidamente. Gli sviluppatori rilasciano nuovi progetti open source su GitHub ogni giorno. Di conseguenza, sta diventando sempre più difficile ottenere il proprio progetto per distinguersi dal mare di software open-source. Tuttavia, puoi fare alcune cose per aumentare le tue possibilità di attirare l’attenzione di altri sviluppatori. Una tecnica efficace e semplice sta mettendo su un file README bello e utile.
Il tuo README dovrebbe essere buono come il tuo progetto., Un ottimo file README aiuta il tuo progetto a distinguersi dal mare di software open-source su GitHub.
Un README è come il volto del tuo progetto. È il primo file che una persona dovrebbe leggere quando incontra un albero dei sorgenti, e dovrebbe essere scritto come un’introduzione molto breve e di base al software.
Un progetto senza README non è così utile. Diamo un’occhiata a questo progetto, per esempio.
Nessun README, nessuna descrizione, niente di niente. Non avrai idea di cosa ha costruito questo ragazzo, non importa quanto sia fantastico.,
Ora diamo un’occhiata a questo progetto. L’autore ha menzionato istruzioni dettagliate e chiare sul progetto e quindi più facile per gli altri da usare e provare.
Un bel README è un buon modo per aiutare le persone a impegnarsi nel progetto. Un progetto con un bel README e screenshot attirerà meglio l’attenzione degli utenti poiché è un modo diretto per spiegare perché questo progetto è importante e perché le persone dovrebbero usare e contribuire al progetto. Un buon README dovrebbe anche includere dettagli sufficienti per aiutare un nuovo utente a iniziare, ad esempio, come compilare, come installare e come avviare l’integrazione.
Ok. Basta parlare. Mostrami come scrivere un buon README allora.
Ora che accetti che README sia importante, ti dirò come scriverne uno. Non è così difficile. Hai solo bisogno di attaccare con alcuni punti elenco. Ecco alcuni dei punti che dovresti tenere a mente mentre scrivi un README.
Formattazione di README?,
Ora che hai insegnato a te stesso come e cosa scrivere in un README, parliamo un po ‘ dello stile di README aka formattazione.
La formattazione è una parte essenziale di README. Puoi imparare come formattare il tuo README da qui e qui.
Alla fine, tieni a mente —
Non è necessario andare a pieno ritmo di sviluppo guidato da Readme, non è necessario includere tutti quei punti elenco , non è necessario seguire alcun processo particolare. Ma scrivere un buon README migliorerà sicuramente le tue capacità di documentazione che ti renderanno uno sviluppatore migliore.,
Leave a Reply