btford / btford/write-good

Suggestion: Offer a solution in warning messages

Open
#56 3 comments 7 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
5.1k
Forks
187
PR merge metrics
No merged PRs in 30d

Description

The following warning message does not provide suggestions on how to fix the issue. I'm stuck not knowing how to fix the issue.

![screen shot 2016-11-04 at 8 52 16 pm](https://cloud.githubusercontent.com/assets/15131271/20007826/9c0d834a-a2d0-11e6-911a-1dfb558f7f4e.png)

I think it'd be educational if there's a copy-pastable link somewhere in the CLI output pointing to a resource that provides:
- Examples on how to fix caught issues
- In-depth rationale behind the warning

If the solution is something trivial such as deleting the offending phrase, adding an instruction (e.g. "consider removing") to the warning message would make it unambiguous.

Contributor guide

No contributing guide indexed for this repository

Research direction

No source file, test, or entry point is named. Start by reproducing the warning shown in the issue screenshot and tracing how the CLI formats warning messages; define the resource link or actionable guidance expected for each affected warning, then verify the output and add coverage for the chosen behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
cli, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.