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

[rush reporter][R10] Publish opt-in reporter docs and demo guide

未关闭
#5,983 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
48/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
活跃
技术栈
nodejs, typescript

调研方向

Start with the demo milestone and the blockers #5978 and #5979, then use the direct rush build demo as the entry point. Document the listed reporter flags, repository opt-in, RUSH_REPORTER, TTY/CI behavior, output contracts, rollback, and cross-version behavior. Done means a clean-checkout demo is reproducible and the migration material is linked from package/API docs and release notes.

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

描述

enhancement

Parent: #5858

Blocked by: #5978; bootstrap-specific documentation also depends on #5979

Goal

Make the opt-in reporter demo reproducible and document the pre-major safety model.

Scope

  • Document --reporter, --output, --log-level, verbosity aliases, the repository experiment, and RUSH_REPORTER.
  • Publish a direct rush build demo showing legacy output, compact default output, AI remediation output, and the full-detail log.
  • Explain TTY/CI behavior, stdout/stderr contracts, color handling, privacy boundaries, and how to disable the feature.
  • Add bootstrap and cross-version behavior after R6 lands.
  • Link the migration material from the package/API docs and release notes.

Acceptance criteria

  • A maintainer can reproduce the demo from a clean checkout using documented commands.
  • The docs clearly distinguish per-invocation opt-in, repository opt-in, future auto-selection, and Rush 6 defaults.
  • Emergency rollback and full-log discovery are prominent.
  • Examples cover interactive, CI, and agent contexts without promising pre-gate auto-selection.

DAG

Runs after the demo milestone and contributes to the Rush 6 migration material.

Part of #5858.

主要语言
TypeScript
星标
6.5k
派生
710
平均合并
1 天 18 小时
30 天内合并 PR
48

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

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

从这里开始

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

microsoft/rushstack 的其他 Issue

查看 microsoft/rushstack 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

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