Docs: README and quickstart say DiffCI "sends nothing by default", but usage counting is on by default
維護者通常 1 天內回覆
評估
- 難度
- 1/5
- 預估耗時
- 1-3 小時
- 新手友好度
- 25/100
- Issue 類型
- 文件
- 描述清晰度
- 描述清楚
- 活躍度
- 停滯
- 技術堆疊
- typescript
研究方向
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.mdintro: "MIT licensed, runs locally, sends nothing by default"README.mdMCP server section: "It needs no account and sends nothing by default."README.mdGitHub 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.tscallsrecordUsage()afterplan(L176),verify(L672),check(L923) andobserve(L1064).recordUsage()intelemetry.tssends adiffci.usage.v1event tohttps://app.diffci.com/v1/usage-eventsunlessDO_NOT_TRACK=1,DIFFCI_NO_SEND=1orDIFFCI_SHARE_USAGE=0is set. In the defaultrepomode the event carriesrepository(host/owner/repo).- The MCP server runs
cli.jswithDIFFCI_MCP=1(mcp.tsL194), so its runs are counted too, withsurface: "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
環境準備
在瀏覽器裡用你自己的 GitHub 帳號啟動這個專案的開發容器。
- 沒有 Dockerfile 或 Docker Compose 檔案
- 沒有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
DiffCI/core 的其他 Issue
-
難度 2/5 1-3 小時 新手友好度 78/100
維護者通常 1 天內回覆
-
Planner: splitParts regex is quadratic on a quote followed by many backticks, so the fuzz test fails at random可能已有人在做 @FredApps 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 86/100
維護者通常 1 天內回覆
-
Agent tools: changed_files lists only the new path of a renamed file可能已有人在做 @FredApps 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 88/100
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 84/100
維護者通常 1 天內回覆
-
adapter good first issue
難度 2/5 1-3 小時 新手友好度 88/100
維護者通常 1 天內回覆
相似的 Issue
-
agent-ready area: ui-server priority: p3 type: test
難度 2/5 1-3 小時 新手友好度 78/100
schlessera/brain-kit#4249 ·
維護者通常 1 天內回覆
-
documentation tool triaged
難度 2/5 1-3 小時 新手友好度 73/100
can1357/oh-my-pi#19608 · 2 則留言 ·
維護者通常 1 天內回覆
-
dependencies tech-debt
難度 2/5 1-3 小時 新手友好度 65/100
bcgov/nr-waste-plus#1549 ·
維護者通常 1 天內回覆
-
enhancement good first issue
難度 2/5 1-3 小時 新手友好度 78/100
blixvip/solana-token-meta#17 ·
-
enhancement good first issue
難度 2/5 1-3 小時 新手友好度 78/100
blixvip/solana-tx-parse#18 ·