the-turing-way/the-turing-way

Add alex style check

Open

#3,767 创建于 2024年6月19日

在 GitHub 查看
 (3 评论) (0 反应) (0 负责人)TeX (2,144 star) (747 fork)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
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
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.
Add alex style check · the-turing-way/the-turing-way#3767 | Good First Issue