Docs: README and quickstart say DiffCI "sends nothing by default", but usage counting is on by default
Maintainer thường phản hồi trong vòng 1 ngày
Đánh giá
- Độ khó
- 1/5
- Thời gian dự kiến
- 1-3 giờ
- Mức phù hợp với người mới
- 25/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- typescript
- Lĩnh vực
- documentation
Hướng nghiên cứu
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.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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.
- Ngôn ngữ chính
- TypeScript
- Star
- 0
- Fork
- 4
- Merge trung bình
- 18 giờ 41 phút
- Pull request đã merge (30 ngày)
- 48
Chuẩn bị môi trường
Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.
- Không có Dockerfile hay tệp Docker Compose
- Không có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của DiffCI/core
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Planner: splitParts regex is quadratic on a quote followed by many backticks, so the fuzz test fails at randomCó thể đã có người làm @FredApps đã nhận hôm nay. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 86/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Agent tools: changed_files lists only the new path of a renamed fileCó thể đã có người làm @FredApps đã nhận hôm nay. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
DiffCI/core#243 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
adapter good first issue
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
Maintainer thường phản hồi trong vòng 1 ngày
Issue tương tự
-
agent-ready area: ui-server priority: p3 type: test
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
schlessera/brain-kit#4249 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
documentation tool triaged
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 73/100
can1357/oh-my-pi#19608 · 2 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
dependencies tech-debt
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
bcgov/nr-waste-plus#1549 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
enhancement good first issue
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
blixvip/solana-token-meta#17 ·
-
enhancement good first issue
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
blixvip/solana-tx-parse#18 ·