Questo materiale era originariamente pubblicato su Habr.com in russo. L'autore ne ha permesso la traduzione e la pubblicazione su Codingsight.
Forse tutti hanno da qualche parte un file in cui conservare alcune cose interessanti e utili, come collegamenti ad articoli, libri, repository, manuali, ecc. Potresti utilizzare i segnalibri in un browser o schede, ancora aperti e in attesa di te. Nel tempo, tutto cresce eccessivamente, i collegamenti si interrompono e i materiali diventano obsoleti.
Ma cosa accadrebbe se potessimo condividere queste preziose gemme con la community? Caricare un file su GitHub? Quindi, le tue scoperte sarebbero utili per qualcun altro. Inoltre, sarebbe più facile mantenere aggiornato il file insieme, aggiornando l'elenco tramite le buone vecchie richieste pull.
Questo è ciò per cui abbiamo il progetto Awesome Lists.
Awesome Lists è tra i primi 10 repository GitHub, vanta già 138.000 "stelle" e un collegamento ai tuoi lavori può raggiungere il suo README principale, attirando così un vasto pubblico. Tuttavia, prima dovrai fare uno sforzo. Qui voglio condividere la mia esperienza.
Sono Maksim Gramin, uno sviluppatore Java e ricercatore di database presso CROC, un'azienda IT internazionale con sede a Mosca. Questo articolo ti parlerà di Awesome List e di come creare il tuo awesome-repo ufficiale.
Di cosa trattano gli elenchi fantastici?
Ogni volta che ho a che fare con qualche nuova tecnologia o un linguaggio di programmazione, ci vado prima, cercando la sezione necessaria e gli elenchi appropriati. Dato il numero grande e sempre crescente di "stelle", non sono l'unica persona con un approccio del genere.
In effetti, "Awesome Lists" è un readme.md semplice standard che vive in un repository separato. Tuttavia, occupa la posizione 8 tra tutti i repository GitHub e include altri elenchi dedicati a determinati argomenti. Ad esempio, la sezione Linguaggi di programmazione contiene gli elenchi Awesome Python e Awesome Go, mentre la sezione Sviluppo front-end memorizza numerosi materiali di sviluppo Web. Ultima ma non meno importante, c'è la sezione Database (ne parleremo un po' più avanti).
Naturalmente, il contenuto non è limitato alle sole materie tecniche e include anche altre sezioni, come Intrattenimento e Giochi. Puoi trovare molte cose eccitanti anche lì (sono stato davvero contento della lista di fantastici fantasy).
La principale distinzione del progetto è che tutti questi elenchi sono gestiti non solo dall'autore, ma dalla comunità. Inoltre, sono tutti realizzati secondo un rigoroso Manifesto Awesome. Ogni elenco rappresenta una comunità separata di specialisti, che vive la propria vita ed è aperto alle tue richieste di pull, il che lo renderà ancora migliore. Inoltre, chiunque può creare il proprio elenco nel caso in cui qualche argomento non sia approfondito.
Per l'idea originale e il coordinamento di tutte queste cose, dovremmo essere grati al leggendario Sindre Sorhus, il primo uomo su GitHub e autore di oltre 1.000 moduli npm. È lui che accetterà le tue richieste di pull.
Come creare una lista impressionante
Se non hai trovato l'elenco giusto per l'argomento necessario, è il primo segno che dovresti farlo da solo! Ti dirò come farlo con l'esempio della mia stessa creazione:Awesome Database Tools.
Progetto dopo progetto, ho dovuto fare i conti con tutti i tipi di database. Così, ho iniziato a gestire alcuni file in cui ho raccolto diversi strumenti utili per il lavoro. C'erano vari DB-migrator, IDE, pannelli di amministrazione, strumenti di monitoraggio, ecc., inclusi quelli che avevo già utilizzato o che avevo pianificato.
Ho condiviso questo file con i miei colleghi di CROC e oltre, incoraggiato dal vedere come ne ha beneficiato molti di loro. Poi volevo di più. Quando ho notato che nella sezione Database mancava un elenco dedicato agli strumenti, ho deciso di aggiungere il mio.
Di cosa hai bisogno?
- Registra un repository GitHub standard e chiamalo come awesome-smth:nel mio caso, era awesome-database-tools.
- Regola l'elenco su fantastico format utilizzando generator-awesome-list che genererà tutti i file necessari nel formato giusto.
- Configura l'integrazione continua (CI) – Awesome-lint e Travis CI ci aiuteranno a controllare la validità dell'elenco.
- Aspetta 30 giorni.
- Esamina almeno altre 2 richieste pull.
- Fai una richiesta pull al repository principale e aggiungi un collegamento al nostro repository. Importante :Leggi attentamente tutti i numerosi requisiti per il nuovo elenco e le richieste pull, e seguili con precisione.
Il mio primo tentativo non è andato a buon fine.
Tuttavia, dopo un po' di tempo, ho raccolto più materiali, ho fatto i compiti, ho corretto gli errori e ho tentato una seconda volta.
Ma ho dimenticato una cosa cruciale e me l'hanno ricordata educatamente:
Non sono stato abbastanza attento e non ho aggiunto un unicorno a conferma del soddisfacimento di tutte le condizioni.
È passato un po' di tempo, ho ricevuto altre osservazioni e aggiunto emendamenti e, alla fine, ho visto un twit tanto atteso che il mio PR era stato accettato.
È così che ho creato il mio primo elenco e ho iniziato a ricevere le richieste pull della community per l'aggiunta di nuovi strumenti. Molti di questi sono già inclusi in Awesome Database Tools.
Se hai buone idee per i database, sentiti libero di condividerle. Inoltre, sarò felice di ricevere feedback da te, come richieste pull e stelle. Se hai domande su come creare le tue liste, faccelo sapere.
Puoi contattare l'autore all'indirizzo [email protected].
