the-turing-way/the-turing-way

Add alex style check

Open

#3,767 opened on 2024年6月19日

GitHub で見る
 (3 comments) (0 reactions) (0 assignees)TeX (2,144 stars) (747 forks)batch import
good first issueinfrastructure

説明

@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)

コントリビューターガイド

技術スタック
nodejsjavascript
領域
devopsci cd
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
fresh
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
mostly clear
前提条件
GitHub Actions or pre commit workflowsbasic Node.js/npm knowledge
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70
調査方針
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.