pypsa-meets-earth/documentation

Harmonise requirements towards markdown formatting

Ouverte

#53 ouverte le 18 mai 2023

Voir sur GitHub
 (1 commentaire) (0 réaction) (0 personne assignée)Jupyter Notebook (118 forks)auto 404
good first issue

Métriques du dépôt

Stars
 (31 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

Guide contributeur

Direction de recherche
Inspectez la configuration CI pour identifier le linter Markdown et ses règles. Ensuite, ajustez la configuration du linter ou le formatage du README pour résoudre les problèmes. Envisagez d'ajouter le linter au pré commit.
Stack technique
Aucun
Domaine
documentationdevops
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85