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

オープン
#286 コメント 0 件 リアクション 0 件 担当者 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分
マージ済み PR(30日)
48

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

DiffCI/core のほかの issue

DiffCI/core の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。