pypsa-meets-earth/documentation

Harmonise requirements towards markdown formatting

Aperta

#53 aperta il 18 mag 2023

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Jupyter Notebook (118 fork)auto 404
good first issue

Metriche repository

Star
 (31 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

Currently CI fails for every PR which introduces any changes into README. The reason in that requirements of github linter used do not quite match with README formatting. In particular, there are following points to be fixed:

  • line length is too big (100..250 vs 80 default);
  • an exclamation mark in a header.

Possible solution:

  1. Include markdown linter into pre-commit
  2. Change linter defaults

Guida contributor

Direzione di ricerca
Controlla la configurazione CI per identificare il linter markdown e le sue regole. Quindi modifica la configurazione del linter o la formattazione del README per risolvere gli errori. Valuta l'aggiunta del linter al pre commit.
Tech stack
Nessuno
Dominio
documentationdevops
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85