Documentation sources are not linted in CI

Ouverte
#8,480 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
64/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
github-actions, markdown
Domaine
ci-cd, documentation

Piste de recherche

Commencez par .github/workflows/docs-pull-request.yml, puis examinez la cible lint dans docs/Makefile et le hook prettier dans .pre-commit-config.yaml. Exécutez les vérifications de lint existantes pour la documentation, corrigez les problèmes actuels de formatage et de Markdown sous docs/ et vérifiez qu’une pull request de documentation présentant un défaut de lint échoue dans CI.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

bug docs

Documentation pull requests pass CI with formatting and Markdown quality defects which should be caught before review. The docs CI workflow only builds the site (.github/workflows/docs-pull-request.yml); the existing lint Makefile target (docs/Makefile) and the repository pre-commit prettier hook (.pre-commit-config.yaml) are never run by CI. As a result, the current documentation sources already fail formatting on 151 files and carry thousands of Markdown lint findings.

Acceptance criteria

  • All current documentation sources under docs/ pass formatting and Markdown lint checks.
  • A documentation pull request that introduces a formatting or Markdown lint defect fails CI.
Langage dominant
Python
Étoiles
7.1k
Forks
603
Merge moyen
3 j 8 h
PR mergées (30 j)
102

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de Flagsmith/flagsmith

Toutes les issues de Flagsmith/flagsmith

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.