Docs: README and quickstart say DiffCI "sends nothing by default", but usage counting is on by default

未關閉
#286 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

@FredApps 已經在處理了。

開始於 2026年11月17日。

  • #287 來自 @FredApps —— 未關閉

評估

難度
1/5
預估耗時
1-3 小時
新手友好度
25/100
Issue 類型
文件
描述清晰度
描述清楚
活躍度
停滯
技術堆疊
typescript
領域
documentation

研究方向

Update the four quoted statements in README.md and docs/using-diffci.md to distinguish usage counting from code and report uploads, and link to docs/telemetry.md. Read the telemetry sections in those docs first. Done means all four statements accurately describe the defaults; issue 287 is already an open linked pull request.

由索引模型根據 Issue 內容生成。

描述

Four places in the docs say DiffCI "sends nothing by default", but the CLI counts runs by default and sends that count with the repository name:

  • README.md intro: "MIT licensed, runs locally, sends nothing by default"
  • README.md MCP server section: "It needs no account and sends nothing by default."
  • README.md GitHub Action section: "diffci check ... writes reports outside the checkout, and sends nothing by default."
  • docs/using-diffci.md "Check selection and runtime": "DiffCI writes its reports outside the repository and sends nothing by default."

What the code does (main @ 40aa308)

  • packages/diffci-cli/src/client/cli.ts calls recordUsage() after plan (L176), verify (L672), check (L923) and observe (L1064).
  • recordUsage() in telemetry.ts sends a diffci.usage.v1 event to https://app.diffci.com/v1/usage-events unless DO_NOT_TRACK=1, DIFFCI_NO_SEND=1 or DIFFCI_SHARE_USAGE=0 is set. In the default repo mode the event carries repository (host/owner/repo).
  • The MCP server runs cli.js with DIFFCI_MCP=1 (mcp.ts L194), so its runs are counted too, with surface: "local-mcp".

The same README contradicts itself a few sections later ("The diffci CLI, the GitHub Action and the MCP server count runs with the repository name"), and docs/telemetry.md and the telemetry section of docs/using-diffci.md describe the count correctly ("Usage counting is on by default"). What is true by default is that no code and no report is uploaded; --no-send and the missing --api-url/--api-token cover reports only.

Expected: the four sentences say what is actually true: reports and code are not uploaded by default, a usage count is, and they link to docs/telemetry.md. Someone who reads only the README intro or the quickstart should not come away thinking nothing leaves the machine.

DiffCI version: CLI 0.3.54 (packages/diffci-cli on main). Docs-only; no behavior change proposed.

主要語言
TypeScript
星號
0
分支
4
平均合併
18 小時 41 分鐘
30 天內合併 PR
48

環境準備

在 Codespaces 中開啟

在瀏覽器裡用你自己的 GitHub 帳號啟動這個專案的開發容器。

  • 沒有 Dockerfile 或 Docker Compose 檔案
  • 沒有 Pull Request 範本
  • 閱讀貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

DiffCI/core 的其他 Issue

查看 DiffCI/core 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。