Alex is a pretty cool tool to check inconsiderate writing, by @wooorm. We should have a plugin for it.
Contributor guide
Tech stack
javascript
Domain
documentationaccessibilitytooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
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
JavaScriptNode.jswrite good plugin architectureAlex API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Explore how existing write good plugins are structured, likely in the 'lib/' directory. Study the Alex API (https://github.com/wooorm/alex) to understand its check function. Create a new plugin file that calls Alex on the input text and formats results as write good warnings.
Add a check with alex · btford/write-good#82 | Good First Issue
