cryptoadvocate/dcsgonefwbspIl pacchetto di supporto per la scheda firmware del primo progetto di badge elettronico di Circuit Crafters.
Per semplificare l'inizio con GitLab, ecco un elenco di passaggi successivi consigliati.
Sei già un professionista? Modifica questo README.md e rendilo tuo. Vuoi semplificare? Usa il template in fondo!
cd existing_repo
git remote add origin https://gitlab.com/cryptoadvocate/dcsgonefwbsp.git
git branch -M main
git push -uf origin main
Usa l'integrazione continua integrata in GitLab.
Quando sei pronto per rendere questo README tuo, modifica questo file e usa il pratico template qui sotto (o sentiti libero di strutturarlo come preferisci - questo è solo un punto di partenza!). Grazie a makeareadme.com per questo template.
Ogni progetto è diverso, quindi considera quali di queste sezioni si applicano al tuo. Le sezioni usate nel template sono suggerimenti per la maggior parte dei progetti open source. Tieni inoltre presente che mentre un README può essere troppo lungo e dettagliato, troppo lungo è meglio che troppo corto. Se pensi che il tuo README sia troppo lungo, considera di utilizzare un'altra forma di documentazione piuttosto che tagliare le informazioni.
Scegli un nome autoesplicativo per il tuo progetto.
Fai sapere alle persone cosa può fare specificamente il tuo progetto. Fornisci contesto e aggiungi un link a qualsiasi riferimento che i visitatori potrebbero non conoscere. Un elenco di funzionalità o una sottosezione di background può essere aggiunta anche qui. Se ci sono alternative al tuo progetto, questo è un buon posto per elencare i fattori differenzianti.
In alcuni README potresti vedere piccole immagini che trasmettono metadati, come se tutti i test del progetto stanno passando o no. Puoi usare Shields per aggiungerne alcuni al tuo README. Molti servizi forniscono anche istruzioni per aggiungere un badge.
A seconda di cosa stai realizzando, può essere una buona idea includere screenshot o anche un video (vedrai spesso GIF anziché video reali). Strumenti come ttygif possono aiutare, ma dai un'occhiata ad Asciinema per un metodo più sofisticato.
All'interno di un particolare ecosistema, può esserci un modo comune di installare le cose, come usare Yarn, NuGet o Homebrew. Tuttavia, considera la possibilità che chi sta leggendo il tuo README sia un principiante e desideri una guida più completa. Elencare passaggi specifici aiuta a rimuovere ambiguità e permette alle persone di iniziare a usare il tuo progetto il più rapidamente possibile. Se funziona solo in un contesto specifico, come una particolare versione del linguaggio di programmazione o sistema operativo, o ha dipendenze che devono essere installate manualmente, aggiungi anche una sottosezione Requisiti.
Usa esempi abbondantemente e mostra l'output atteso se possibile. È utile avere l'esempio più piccolo di utilizzo che puoi dimostrare, fornendo collegamenti ad esempi più sofisticati se sono troppo lunghi per essere ragionevolmente inclusi nel README.
Dì alle persone dove possono andare per aiuto. Può essere qualsiasi combinazione di un tracker delle issue, una chat, un indirizzo email, ecc.
Se hai idee per release future, è una buona idea elencarle nel README.
Dichiara se sei aperto ai contributi e quali sono i tuoi requisiti per accettarli.
Per le persone che vogliono apportare modifiche al tuo progetto, è utile avere della documentazione su come iniziare. Forse c'è uno script che dovrebbero eseguire o alcune variabili d'ambiente che devono impostare. Rendi questi passaggi espliciti. Queste istruzioni potrebbero essere utili anche al te futuro.
Puoi anche documentare comandi per il linting del codice o l'esecuzione dei test. Questi passaggi aiutano a garantire un'alta qualità del codice e riducono la probabilità che le modifiche rompano involontariamente qualcosa. Avere istruzioni per eseguire i test è particolarmente utile se richiede una configurazione esterna, come avviare un server Selenium per testare in un browser.
Mostra il tuo apprezzamento a coloro che hanno contribuito al progetto.
Per i progetti open source, indica come è concesso in licenza.
Se hai esaurito energia o tempo per il tuo progetto, inserisci una nota all'inizio del README dicendo che lo sviluppo è rallentato o si è fermato completamente. Qualcuno potrebbe scegliere di fare un fork del tuo progetto o offrirsi come manutentore o proprietario, permettendo al tuo progetto di continuare. Puoi anche fare una richiesta esplicita di manutentori.