Docs: README and quickstart say DiffCI "sends nothing by default", but usage counting is on by default
Maintainer antworten meist innerhalb von 1 Tag
Bewertung
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- 1-3 Stunden
- Anfängerfreundlichkeit
- 25/100
- Issue-Typ
- Dokumentation
- Klarheit
- Klar beschrieben
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- typescript
- Bereich
- documentation
Rechercherichtung
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.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 0
- Forks
- 4
- Ø Merge
- 18 Std. 41 Min.
- Gemergte PRs (30 T.)
- 48
Entwicklungsumgebung
Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.
- Kein Dockerfile und keine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus DiffCI/core
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
Maintainer antworten meist innerhalb von 1 Tag
-
Planner: splitParts regex is quadratic on a quote followed by many backticks, so the fuzz test fails at randomEvtl. vergeben @FredApps hat das heute übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 86/100
Maintainer antworten meist innerhalb von 1 Tag
-
Agent tools: changed_files lists only the new path of a renamed fileEvtl. vergeben @FredApps hat das heute übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 84/100
DiffCI/core#243 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
adapter good first issue
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
Maintainer antworten meist innerhalb von 1 Tag
Ähnliche Issues
-
agent-ready area: ui-server priority: p3 type: test
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
schlessera/brain-kit#4249 ·
Maintainer antworten meist innerhalb von 1 Tag
-
documentation tool triaged
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 73/100
can1357/oh-my-pi#19608 · 2 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
-
dependencies tech-debt
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100
bcgov/nr-waste-plus#1549 ·
Maintainer antworten meist innerhalb von 1 Tag
-
enhancement good first issue
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
blixvip/solana-token-meta#17 ·
-
enhancement good first issue
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
blixvip/solana-tx-parse#18 ·