pypsa-meets-earth/documentation

Harmonise requirements towards markdown formatting

Aberta

#53 aberto em 18 de mai. de 2023

Ver no GitHub
 (1 comentário) (0 reação) (0 responsável)Jupyter Notebook (118 forks)auto 404
good first issue

Métricas do repositório

Stars
 (31 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Verifique a configuração de CI para identificar o linter de markdown e suas regras. Em seguida, ajuste a configuração do linter ou a formatação do README para resolver as falhas. Considere adicionar o linter ao pre commit.
Pilha de tecnologia
None
Domain
documentationdevops
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85