Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

[feedback] help, --help, or usage in cli

未关闭
#295 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
58/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
typescript
领域
cli

调研方向

Start at the CLI entry point that handles usabl check and argument parsing; the report shows that --help, help, and no arguments currently trigger the approval gate. Read the CLI command tests first and identify how help output is expected to bypass checks. Done means users can discover how to run a report from the CLI without opening the docs.

由索引模型根据 Issue 内容生成。

描述

area: cli enhancement
Surface

cli

Verdict seen

Needed help getting started

Expected verdict

A bit more contextual help for how to use the CLI, without having to go look for docs

Repro

Hey, I found the CLI a bit tricky to get started with. I'm just trying to get a report of issues against the project, I don't want it to PR anything yet. It should be great if more usage or contextual help was available on the CLI;

user@host: npx usabl check
usabl: ■ APPROVAL REQUIRED (exit 2)
  This change edits guarded policy files. It needs approval on the pull request.
  gate summary: approval required: 2 guarded path(s) changed
  guarded paths changed: usabl.config.json, usabl.routes.json
  accessibility exit code: 0
user@host: npx usabl check --help
usabl: ■ APPROVAL REQUIRED (exit 2)
  This change edits guarded policy files. It needs approval on the pull request.
  gate summary: approval required: 2 guarded path(s) changed
  guarded paths changed: usabl.config.json, usabl.routes.json
  accessibility exit code: 0
user@host: npx usabl check help
unknown command: help
user@host: npx usabl help
unknown command: help
user@host: npx usabl
usabl: ■ APPROVAL REQUIRED (exit 2)
  This change edits guarded policy files. It needs approval on the pull request.
  gate summary: approval required: 2 guarded path(s) changed
  guarded paths changed: usabl.config.json, usabl.routes.json
  accessibility exit code: 0
Honest or confusing?

No response

主要语言
TypeScript
星标
0
派生
0
平均合并
2 小时 48 分钟
30 天内合并 PR
8

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 有 Pull Request 模板
  • 没有贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

usabl-dev/usabl 的其他 Issue

查看 usabl-dev/usabl 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。