Docs: README and quickstart say DiffCI "sends nothing by default", but usage counting is on by default
Los mantenedores suelen responder en 1 día
Evaluación
- Dificultad
- 1/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Estancado
- Stack tecnológico
- typescript
- Área
- documentation
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- TypeScript
- Estrellas
- 0
- Forks
- 4
- Merge medio
- 18 h 41 min
- PR fusionados (30 d)
- 48
Preparar el entorno
Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de DiffCI/core
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día
-
Planner: splitParts regex is quadratic on a quote followed by many backticks, so the fuzz test fails at randomPosiblemente ocupada @FredApps la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
Los mantenedores suelen responder en 1 día
-
Agent tools: changed_files lists only the new path of a renamed filePosiblemente ocupada @FredApps la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
DiffCI/core#243 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
adapter good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
Los mantenedores suelen responder en 1 día
Todos los issues de DiffCI/core
Issues similares
-
agent-ready area: ui-server priority: p3 type: test
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
schlessera/brain-kit#4249 ·
Los mantenedores suelen responder en 1 día
-
documentation tool triaged
Dificultad 2/5 1-3 horas Aptitud para principiantes 73/100
can1357/oh-my-pi#19608 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
-
dependencies tech-debt
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
bcgov/nr-waste-plus#1549 ·
Los mantenedores suelen responder en 1 día
-
enhancement good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
blixvip/solana-token-meta#17 ·
-
enhancement good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
blixvip/solana-tx-parse#18 ·