the-turing-way/the-turing-way

Add alex style check

Open

#3.767 geöffnet am 19. Juni 2024

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TeX (2.144 Stars) (747 Forks)batch import
good first issueinfrastructure

Beschreibung

@sgibson91 brought up alex in Slack. It is a linter which checks for insensitive and inconsiderate language.

It is configurable and can raise both warning and errors, so we should be able to block what we feel in unacceptable but have the flexibility to question possibly insensitive language.

This could be added as a CI check (and in pre-commit #3651)

Contributor Guide

Tech Stack
nodejsjavascript
Domain
devopsci cd
Issue Type
feature
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.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
GitHub Actions or pre commit workflowsbasic Node.js/npm knowledge
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70
Research-Richtung
This issue proposes adding alex, a linter for insensitive language, as a CI check and optionally in pre commit hooks. The repository uses GitHub Actions for CI (implied). Look at the existing CI configuration in the repository (likely .github/workflows) to understand how other linting steps are set up. Then adapt alex's setup, following its documentation. The issue mentions a related pre commit issue (#3651) which may provide additional context. No existing PR or assignment, so it's open for contribution.