Ribasso

Buona giornata, colleghi! Dopo un lungo percorso di apprendimento, tutti vogliono mostrare al datore di lavoro i propri frutti e mostrarli solo dal lato migliore e professionale, giusto? Penso di si. Pertanto, oltre ad un progetto correttamente concepito e realizzato, dobbiamo essere in grado di formalizzarlo. Il datore di lavoro non leggerà tutto il codice del tuo progetto per capire di cosa si tratta e cosa è incluso in esso? In questo articolo riassumeremo infine le due precedenti, ovvero: Continuous Integration e Code Coverage , e ci faremo capire sul “fronte” del progetto open source cosa abbiamo utilizzato nel nostro progetto e cosa rappresenta. Oggi vi parleremo di Markdown, faremo le nostre domande preferite: "Che cos'è?" e "Perché è questo?", scopriamo dove viene utilizzato e come lavorarci. Ci sarà anche un esempio, lo implementeremo nel nostro progetto open source . Quindi andiamo!

Cos'è il "Ribasso"?

Dato che tu ed io siamo programmatori, andremo immediatamente su Google e apriremo il primo collegamento Wiki , che dice: Markdown è un linguaggio di markup leggero creato con l'obiettivo di scrivere il testo più leggibile e facile da modificare, ma adatto a conversione verso linguaggi per pubblicazioni avanzate (HTML, Rich Text e altri). Qui a dire il vero non ho molto da aggiungere, credo che questa sia una spiegazione quasi perfetta.

Perché abbiamo bisogno di questo "Markdown"?

Ad essere onesti, in realtà non è male senza di esso :D Ma ricordiamo il nostro obiettivo: scrivere un modello di progetto competente che abbia già l'integrazione continua e abbia statistiche di Code Coverage sulla risorsa Codecov. Perché l'ho menzionato? Inoltre, Markdown ci consentirà di prendere dati da queste risorse e fornire i dati stessi, o badge che ci reindirizzeranno dove abbiamo bisogno di ottenere queste informazioni. È conveniente avere tutto su una pagina “titolo”, piuttosto che sparpagliata in posti diversi, non è vero?

Dove viene utilizzato?

Chiunque abbia caricato almeno una volta uno qualsiasi dei propri progetti su GitHub sa che GitHub vuole invitarti insistentemente a creare un file README: qual è l'estensione di questo file? Esatto, Bolt conosce Markdown! Come già sappiamo, questo file può essere adattato molto facilmente a molti formati e convertito nell'HTML di cui abbiamo bisogno. Ma prendiamoci il nostro tempo e non affrettiamoci ad aggiungerlo subito direttamente su GitHub.

Come lavorarci?

Innanzitutto, come avrai notato, possiamo aggiungerlo direttamente a GitHub e funzionerà! Ma non è sempre necessario aggiungerlo a un solo progetto, ad esempio. Oppure, ad esempio, vogliamo pensare di più a come lo creiamo. E qui GitHub non è più adatto a noi. E in generale, possiamo creare file Markdown non solo allo scopo di inviarli a GitHub. In secondo luogo, potremmo crearlo direttamente tramite IDEA, che è esattamente ciò che faremo, ma non subito, perché abbiamo bisogno di un potente ambiente di sviluppo per scrivere un piccolo file? Qui ti consiglio di sfogliare il catalogo di editor di file Markdown facili e non così facili. Per quanto mi riguarda, ho scelto Haroopad , è molto semplice, accessibile, ha una rappresentazione istantanea di ciò che stai scrivendo (anche IDEA lo fa) e ha un suggerimento sulla sintassi. Ecco come appare la finestra dell'editor: Qui ho aperto un README.md già pronto di uno dei miei progetti. A sinistra c'è un cheat sheet, a destra c'è un display, al centro c'è il testo. Tutto è molto primitivo e semplice. Puoi anche vedere i badge, di cui parleremo tra poco. Coloro che scelgono un modo diverso di scrivere questi file non si allarmano, tutto ciò che sarà diverso sarà l'interfaccia grafica. Il testo, la sintassi e la visualizzazione rimarranno invariati. Esempio Il compito è molto semplice: scrivere README.md in modo che contenga: informazioni sul progetto (compresi i badge), informazioni sull'importazione del progetto, informazioni sull'implementazione del progetto, informazioni sui contatti dell'autore. Tutto è molto semplice e primitivo, come ho già detto. Andiamo al sodo.

1. Scriviamo un titolo: il nome del nostro progetto.

   L'intestazione principale e più grande viene creata utilizzando l'operatore hash " # " e quindi viene scritto il titolo. Nel nostro caso:

   # ForJavaRushPublication

2. Quindi scriveremo un titolo leggermente più piccolo e scriveremo "Informazioni sul progetto". L'intestazione più piccola è preceduta da più " # ":

   ## Information

   E poi scriveremo le informazioni sul progetto.

3. Inseriamo i link ai nostri articoli. Questo viene fatto in modo molto semplice e, se usi Haroopad, digita semplicemente il cheat sheet e il modello verrà inserito da solo. La sintassi è: " [testo](url) ";

4. Inseriamo i badge. Diamo uno sguardo più da vicino qui.

   Per prima cosa disponiamoli sotto forma di tavolo, per bellezza. Ci saranno 2 colonne e 2 colonne. La sintassi sarà simile a questa:

   E il risultato sarà così:

   Successivamente inseriremo i collegamenti ipertestuali ai nostri badge, ma dove possiamo trovarli? Nell’articolo precedente ho mostrato dove trovare Codecov, ma non ho menzionato quale trovare. Poiché abbiamo un file Markdown, abbiamo bisogno anche di un badge Markdown:

   Basta copiarlo e incollarlo in una colonna nel nostro Markdown. Ma non dimenticare che Codecov è apparso nel ramo JaCoCo, ma non in master, quindi dovrai correggerlo manualmente. Il Travis CI Badge si trova direttamente di fronte al nome del progetto, dove il build log è:

   Selezioniamo il badge e quindi viene visualizzata la finestra delle impostazioni:

   Selezioniamo sicuramente Markdown e il ramo di cui hai bisogno. Creerò README.md per due rami e saranno leggermente diversi, perché non ho ancora implementato Codecov nel ramo master.




5. Scriviamo le informazioni su come importare o clonare questo progetto. Non spiegherò come farlo, ma puoi leggerlo nel mio README.md. Scriveremo delle tecnologie che abbiamo utilizzato nel nostro progetto, inserendo collegamenti ad esse. Tuttavia, questo è un progetto educativo. Bene, scriviamo le informazioni di contatto.




6. Il nostro Markdown è pronto. Tutto quello che dobbiamo fare è aggiungerlo al nostro progetto e il gioco è fatto. Ma non tutto in una volta! Apriamo la nostra IDEA e nei Plugin controlliamo che tu abbia il supporto Markdown:

   Ho Ultimate IDEA, quindi ho tutto, il tuo plugin potrebbe non essere installato di default, ma quando crei un file con estensione md, ti dovrebbe essere chiesto di scaricarlo. Scarica e riavvia la tua IDEA.




7. Dopo aver importato il Markdown che abbiamo scritto, aprilo tramite IDEA e modificalo se necessario. Ecco come appare tramite IDEA:

   Spingiamo. Quindi vediamo che quando si apre un progetto, le informazioni su di esso vengono immediatamente caricate, questo è il nostro README.md:

   Ora, quando clicchiamo sul badge, possiamo passare direttamente all'assemblaggio del progetto e vedere cosa abbiamo lì e come.




8. Farò lo stesso per il ramo JaCoCo per dimostrare Codecov Badge, perché non abbiamo ancora README.md. Di conseguenza, ora abbiamo due badge:

   Codecov mostra la percentuale di copertura del codice e può anche reindirizzarci alla pagina Codecov e mostrare un rapporto dettagliato sulla copertura del codice.

link utili

• Cosa ci dice Wiki su Markdown;
• Directory degli editori di Markdown ;
• Haroopad che consiglio;
• Informazioni su Markdown sul sito Web JetBrains ;
• Markdown Navigator sullo stesso JetBrains;
• Distintivi e tutto ciò che li riguarda. Qui puoi scegliere lo stile di qualsiasi badge e personalizzarlo per te;
• Come aggiornare il tuo progetto open source? Anche questo articolo risponderà ;
• Articolo precedente

Riassumiamo la serie dei miei articoli

1. Abbiamo visto cos'è la CI, a cosa serve e come usarla nel primo articolo sull'Integrazione Continua ;
2. Abbiamo giocato con CC e abbiamo capito cos'è e perché è necessario nel secondo articolo su Code Coverage ;
3. E in questo articolo abbiamo esaminato cos'è Markdown, perché è necessario e come utilizzarlo in modo efficace.

Grazie a tutti per aver letto questi tre lunghi articoli, spero che vi siano stati utili. Potrebbero esserci errori ed omissioni nel testo. Grazie a tutti per l'attenzione!