ilcors-dev
commented
1 year ago v0
- l'applicazione deve, almeno inizialmente, puntare a fornire un punto di partenza per gli sviluppatori per quanto riguarda la redazione dei README NON deve produrre un README perfetto pronto per il publish
- puntiamo a produrre la lista messa sopra il più completa possibile
- in caso di più file di config presenti nelle directory eg. composer.json+package.json (laravel) fare merge delle informazioni trovate nei config, in caso di conflitto eg 'name' in entrambi i file mostrare in modo interattivo all'utente e dargli la scelta (mostrando i valori) #5
- mettiamo ogni sezione, anche se non trovata nei file di config: se non c'è mettere TODO o lorem ipsum (da valutare cosa infilarci). eg non c'è il campo description ne nel composer.json ne nel package.js => mettiamo sezione descrizione in ogni caso con un testo che indichi il todo #7
- no immagini
Scomposizione
Header
- titolo del progetto con emoji random
- shield per le seguenti informazioni:
- licenza
- versione
- tecnologie (eslint, tailwindcss, prettier ecc)
- download (non in questa fase, punto aperto: come capire i download del package? è oss? è su npm? ecc)
- stars github (non in questa fase, punto aperto: è su github? gitlab? ecc)
- mettere 4 link vuoti con emoji (es: vedi qua
- sezione
key featuresabout #nomerepo con elenco puntato di lorem ipsumBody
- installazione (chiedere qual è o quali sono i package manager di riferimento e in base a questo generare i comandi sotto)
- git clone
- cd repo
- usage lasciare in todo
- configuration lasciare in todo
- ignoriamo
Who usesInfo / Footer
- how to contribute (prendere spunto da qua
- inserire le guidelines più comuni eg conventional commits, semantic versioning
- se in git repository sarebbe bello mettere link a issues, pull requests ecc
- contributors estrapolabili da git
- licenza magari scrivere anche qualche info a riguardo
- author + support (by me a coffee ecc)
BabelDev0
Dobbiamo decidere quale sezioni mettere nel template e capire quali possono essere comprese in automatico quali no
Sections
Header
Table of Contents
Body
To use
Footer