Make this Monkey great Again 🦍 #48
Description
Penso sia arrivato il momento di cercare di migliorare ancora di più questa repo per guidare il più possibile le persone su come contribuire, effettuare alcuni controlli automatici sulle PR ed il loro contenuto, fornire varie guide su come utilizzare GitHub o configurare i vari IDE e rendere il più possibile uniformi i vari appunti.
Wiki
Pensavo di aprire una Wiki qui su GitHub per andarci a scrivere alcune guide:
- Setup dell'ambiente di sviluppo:
- VSCode + Docker
- TexStudio + MikTex + LuaLatex
- Eventuali sezioni di Troubleshooting (doc(wiki): Troubleshooting LuaTex con TeXstudio e MiKTeX #46)
- Breve guida su come installare e configurare git e GitHub e come contribuire
README
Potremmo migliorare il README con le seguenti modifiche:
- Vari badge come Wiki, Numero PR, Numero Issues, Numero Stars, Versione Attuale, ...
- Ricontrollare vari typo ed impaginazione
- Aggiungere emoji ai titoli (?)
- Sezione Credits migliorata (Parte Credits nel README repo #47)
- Breve spiegazione su come contribuire (?)
- Breve spiegazione sugli appunti ed il loro contenuto (?)
Automazioni
Possiamo cercare di rendere automatici alcuni controlli ed azioni:
- Per ora abbiamo un'action che tagga il codice in automatico (esempio v2.1.3) e ne effettua la release. Potrebbe essere migliorato (?)
- Controllare in automatico le PR:
- Controllare che il nome della PR rispecchi gli standard della community (
feat:,fix:,doc:, ecc.) - Contenga dei file specifici (per esempio, deve esserci per forza un
main.tex, ecc.) - Controlli l'ortografia dei file modificati
- Controlli eventuali errori sintattici di LaTex (chktex)
- Controllare che il nome della PR rispecchi gli standard della community (
- Bot per i contributor (?)
- Action per i contributor (?)
Repo
- Modificare le labels aggiungendone di più significative
- Aprire la sezione Discussioni (?)
- Completare la sezione "Community Standards":
- Aggiungere il Code of Conduct
- Contributing
- Secure policy (?)
- Pull Request Template
- Repository admins accept content reports (?)
Appunti
Dovremmo trovare il modo di rendere il più uniforme possibile il template degli appunti
- utilizzare i submodules di git e mettere il devcontainer ed il template in una repo a parte facendo in modo di poter modificare solo alcune parti (?)
- introdurre uno standard nel formato e contenuto, del tipo per i vari appunti deve esserci per forza un README che indica le parti del programma (checkbox) e gli argomenti coperti dalle dispense (così possiamo sapere subito se quegli appunti sono completi oppure no); non si usano
vspacein determinate parti del codice; vengono individuate alcune componenti standard da utilizzare tipo come formattare i paragrafi ecc.