Ottimizzare il lavoro con i tuoi progetti su GitHub: familiarizzare con Github Template Repository

Ciao a tutti, comunità JavaRush! Oggi parleremo di open source e di cosa serve per creare un progetto di alta qualità OLTRE al codice che viene scritto. È importante scrivere un prodotto utile. Ma non meno importante è la corretta progettazione del repository (repository del progetto su GitHub). Ciò aiuterà a implementare un altro punto chiave: la promozione del prodotto. Anche se il progetto è super interessante, ma è mal progettato, non è descritto almeno nel README (puoi leggere cos'è un README qui ), la licenza non è indicata, ecc., ecc., ci sarà nessun successo. È solo che nessuno lo noterà. E se qualcuno se ne accorge, non saprà come interagire con lui. Ci sono molte cose che devono essere compilate più e più volte, e non è facile per il programmatore copiare e incollare ogni volta, e proprio per questo, quest'estate, GitHub ha rilasciato la funzione Template Repository che aiuta in questo. Per così dire, per automatizzare il processo di creazione di nuovi progetti. Oggi capiremo cos'è un Repository e cos'è un Template Repository. Descriveremo cosa dovrebbe esserci nel progetto oltre al codice, su quali cose devi concentrarti. Creiamo un template repository da zero e aggiungiamo tutto il necessario dal mio punto di vista. Infine, utilizzeremo Template Repository durante la creazione di un nuovo repository. Ma prima capiamo i termini. Teoria: cosa dovrebbe esserci nel repository generale di qualsiasi progetto Ogni progetto open source su GitHub dovrebbe avere un profilo comunitario ben descritto , che contiene i seguenti elementi.

1. Modello di emissione

Qui è necessario descrivere le regole per creare un problema nel repository: come dovrebbero essere chiamati, quale sarà l'etichetta, chi le verrà assegnato. Quando si crea un nuovo numero, verranno offerte le seguenti opzioni:

• Segnalazione di bug : creazione di un problema per descrivere un difetto nel progetto;
• Richiesta di funzionalità - proposta di una nuova idea per un progetto;
• Richiesta di miglioramento - proposta di miglioramento del progetto;
• Modello di problema personalizzato : se le altre opzioni non funzionano, puoi utilizzare un modello vuoto.

Un esempio di come appare può essere visto qui .

2. Licenza

La licenza con cui è scritto il progetto. È necessario affinché chi utilizzerà il progetto sappia cosa è garantito e cosa no. Ad esempio, la licenza Apache 2.0 dice quanto segue:

3.LEGGIMI

Questa è la descrizione del progetto, il suo biglietto da visita. Tutto ciò che c'è da dire sul progetto dovrebbe essere qui. Certo, bisognerà descriverlo ogni volta, tenendo conto delle specificità del progetto, ma i titoli saranno gli stessi. Per esempio:

• Panoramica: una breve descrizione del progetto;
• Utilizzo: come utilizzare il progetto;
• Costruire: come avviare un progetto, cosa è necessario per questo;
• Risoluzione dei problemi: descrive quali problemi potresti incontrare e come risolverli;
• Note di rilascio - descrizione delle modifiche a seconda della versione;
• Autori: non dimenticare i tuoi cari;
• Contribuire - una descrizione di come puoi partecipare allo sviluppo del progetto;
• Codice Etico – descrizione delle regole di partecipazione;
• RELEASE_NOTES - un file in cui vengono registrate tutte le modifiche per le nuove versioni. È una buona pratica inserirlo in un documento separato e memorizzare un collegamento nel README;
• CONTRIBUTING è un file che descrive come puoi contribuire allo sviluppo di questo progetto. Creato come file separato per l'intestazione Contributing nel README;
• CODE_OF_CONDUCT - un file che descrive le regole per partecipare allo sviluppo del progetto;
• Modello di richiesta pull : un modello per coloro che creeranno una richiesta pull.

Tutte queste cose vengono utilizzate da progetto a progetto, indipendentemente dal linguaggio di programmazione o dalle sue specifiche.

Esercizio: creare il proprio modello

Come si suol dire, passiamo dalle parole ai fatti. Ora, utilizzando un esempio, ti mostrerò come creare il tuo modello.

1. La prima cosa di cui hai bisogno è un account su GitHub/ registrati lì .

2. Crea un nuovo repository: per fare ciò, fai clic su + nell'angolo in alto a destra

3. Durante la creazione, compila:

   • Nome del repository: nel mio caso repository-template;
   • Descrizione: breve descrizione del progetto;
   • Lasciamo Pubblico, anche se puoi selezionare Privato;
   • Controlla la casella di inizializzazione README:

   • Seleziona la licenza con la quale il progetto sarà:

     Poiché nel mio caso il modello è generale, gitignore non è necessario: verrà aggiunto per un progetto e un linguaggio di programmazione specifici.

     Clicca quindi su Crea Repository , completando così il processo di creazione. Il sistema ci porterà automaticamente al repository appena creato.

4. Compilando il Profilo della Community : nel repository creato, vai alla scheda Approfondimenti e seleziona Community :

   Come puoi vedere, non resta che compilare il modello Code of Conduce, Contributing, Issue Template, Pull Request.

   Utilizzando l'esempio del Codice di condotta, mostreremo come aggiungerli a un progetto.

   Fai clic su Aggiungi , il sistema ti chiede di selezionare Patto del collaboratore o Codice di condotta del cittadino :

   Seleziono il primo e faccio clic su Rivedi e invia .

   Successivamente, puoi modificare questo file e confermarlo.

   In basso, seleziona l'opzione Salva direttamente nel ramo principale e fai clic su Salva nuovo file :

   Di conseguenza, se torniamo al Profilo della comunità , troveremo che il Codice di condotta è contrassegnato come aggiunto:

   Contributing e Issue Template vengono aggiunti in modo simile, quindi non li mostrerò. Fallo da solo ;)

5. Aggiungi il modello di richiesta pull .

   Ma parliamo di questo separatamente.

   Non so perché GitHub non abbia aggiunto la stessa comoda opzione per impostare il modello Pull-Request, quindi dovrai studiare la documentazione e aggiungerla manualmente.

   Per fare ciò, fai clic su Crea nuovo file nella radice del repository :

   Il nome del file dovrebbe essere: .github/pull_request_template.md .

   Aggiungiamo ciò di cui abbiamo bisogno al modello e facciamo clic su Commit new file , come abbiamo fatto sopra. Non avevo intenzione di reinventare la ruota e ho trovato un esempio che mi sembrava abbastanza utilizzabile.

   In questo modo verrà compilato l'intero Profilo della Community:

6. Aggiungi un indicatore di repository di modelli .

   Per fare ciò, vai all'opzione Impostazioni nel repository e seleziona la casella dove dice Template Repository:

   Ed è tutto, il modello per creare nuovi progetti è pronto. Pertanto, risparmieremo molto tempo in futuro quando avremo bisogno di creare nuovi progetti. Questo ti aiuterà anche a non perdere dettagli importanti, poiché spesso capita di dimenticare di aggiungere qualcosa, ad esempio una licenza o un modello chiaro per un problema.

Come utilizzare l'archivio modelli

Ci sono due opzioni per l'uso:

1. Quando un modello è di tua proprietà diretta: quando crei un nuovo repository, ti verrà data la possibilità di creare da un modello dall'elenco dei modelli di tua proprietà:

2. Se il modello è estraneo: anche qui non ci sono problemi particolari. Vai a quel modello e fai clic sul pulsante Usa questo modello . Qui userò l'animazione dal documento ufficiale:

Riassumiamo

In questo articolo abbiamo esaminato:

• cos'è il repository GitHub;
• cos'è il repository dei modelli;
• cosa dovrebbe essere nel repository dei modelli;
• come creare un repository di modelli;
• come utilizzare il repository di modelli.

Naturalmente, sulla base di questo modello, puoi già crearne di più specifici. Ad esempio, ho creato più modelli con sistemi di compilazione Maven o Gradle già configurati. Inoltre: puoi creare un modello di repository Spring Boot basato sugli ultimi due. Per raggruppare tutti i modelli, ho creato un'organizzazione di repository di modelli su GitHub con tutti i modelli. Iscriviti al mio account GitHub

link utili

• Organizzazione con tutti i modelli che ho creato
• Blog GitHub: Genera un nuovo repository con modelli di repository come creare un modello per i repository
• Guida GitHub: Informazioni sui repository su cosa sono i repository.
• Guida GitHub: Creazione di un repository da un modello come creare un nuovo progetto basato su un modello
• Guida di GitHub: Licenza, una descrizione del repository delle licenze per i progetti
• Guida GitHub: crea una descrizione del repository per la creazione di un repository
• Guide Open Source suggerimenti per creare/descrivere progetti open source.
• Guida GitHub: aggiunta di un modello di richiesta pull : creazione di un modello per richieste pull.

Altri miei articoli

• Debug in Intellij IDEA: una guida per principianti
• Guida per creare un client per l'API di Skyscanner e pubblicarlo in jCenter e Maven Central [Parte 1]
• Guida per creare un client per l'API di Skyscanner e pubblicarlo in jCenter e Maven Central [Parte 2]
• Creare un sistema di monitoraggio dei prezzi dei biglietti aerei: una guida passo passo [Parte 1]
• Creare un sistema di monitoraggio dei prezzi dei biglietti aerei: una guida passo passo [Parte 2]
• Creare un sistema di monitoraggio dei prezzi dei biglietti aerei: una guida passo passo [Parte 3]
• Logging: cosa, come, dove e con cosa?
• Come un test di intervista si è trasformato in una libreria open source
• Storia di successo. 20 ore di programmazione settimanali, laurea magistrale e vita personale
• Come trovare lavoro? Consigli per l'invio dei curriculum