Documentation sources are not linted in CI

Aperta
#8,480 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
64/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
github-actions, markdown

Direzione di ricerca

Inizia da .github/workflows/docs-pull-request.yml, quindi esamina il target lint in docs/Makefile e l’hook prettier in .pre-commit-config.yaml. Esegui i controlli di lint della documentazione esistenti, risolvi i problemi attuali di formattazione e Markdown in docs/ e verifica che una pull request della documentazione con un difetto di lint fallisca in CI.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.
Lingua principale
Python
Stelle
7.1k
Fork
603
Merge medio
3g 8h
PR unite (30g)
102

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Flagsmith/flagsmith

Tutte le issue di Flagsmith/flagsmith

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.