Docs: README and quickstart say DiffCI "sends nothing by default", but usage counting is on by default
I maintainer di solito rispondono entro 1 giorno
Valutazione
- Difficoltà
- 1/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 25/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Ferma
- Stack tecnologico
- typescript
- Ambito
- documentation
Direzione di ricerca
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.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- TypeScript
- Stelle
- 0
- Fork
- 4
- Merge medio
- 18h 41m
- PR unite (30g)
- 48
Preparare l'ambiente
Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di DiffCI/core
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
-
Planner: splitParts regex is quadratic on a quote followed by many backticks, so the fuzz test fails at randomForse già presa @FredApps l’ha presa oggi. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 86/100
I maintainer di solito rispondono entro 1 giorno
-
Agent tools: changed_files lists only the new path of a renamed fileForse già presa @FredApps l’ha presa oggi. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
DiffCI/core#243 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
adapter good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
I maintainer di solito rispondono entro 1 giorno
Issue simili
-
agent-ready area: ui-server priority: p3 type: test
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
schlessera/brain-kit#4249 ·
I maintainer di solito rispondono entro 1 giorno
-
documentation tool triaged
Difficoltà 2/5 1-3 ore Idoneità per principianti 73/100
can1357/oh-my-pi#19608 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
dependencies tech-debt
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
bcgov/nr-waste-plus#1549 ·
I maintainer di solito rispondono entro 1 giorno
-
enhancement good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
blixvip/solana-token-meta#17 ·
-
enhancement good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
blixvip/solana-tx-parse#18 ·