btford/write-good

Add a check with alex

Open

#82 geöffnet am 26. Juli 2017

Auf GitHub ansehen
 (0 Kommentare) (4 Reaktionen) (0 zugewiesene Personen)JavaScript (212 Forks)batch import
enhancementhelp wanted

Repository-Metriken

Stars
 (4.810 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

Alex is a pretty cool tool to check inconsiderate writing, by @wooorm. We should have a plugin for it.

Contributor Guide

Research-Richtung
Untersuche, wie bestehende write good Plugins strukturiert sind, wahrscheinlich im Verzeichnis 'lib/'. Studiere die Alex API (https://github.com/wooorm/alex), um deren Prüffunktion zu verstehen. Erstelle eine neue Plugin Datei, die Alex auf den Eingabetext anwendet und die Ergebnisse als write good Warnungen formatiert.
Tech Stack
javascript
Domain
documentationaccessibilitytooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
JavaScriptNode.jswrite good plugin architectureAlex API
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
45