pingcap/tidb

Introduce text file analysis tool that detects non-inclusive language in TiDB repo

Open

#20,439 opened on Oct 14, 2020

View on GitHub
 (7 comments) (0 reactions) (1 assignee)Go (40,090 stars) (6,186 forks)batch import
good first issuehelp wantedtype/enhancement

Description

woke — Check for insensitive language in your source code https://github.com/get-woke/woke

Contributor guide

Tech stack
go
Domain
tooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with GoExperience with CI configuration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Review the TiDB repository's current CI configuration (likely in .github/workflows) to understand how linting tools are integrated. Investigate the woke tool's configuration and integrate it as a new GitHub Actions step. Check the issue comments for any prior discussion or rejected approaches. Ensure the tool is run on all PRs and that any non inclusive language findings are surfaced.