Skip to content

codev.telemetry setting description reads as informational, not as a control #840

@amrmelsayed

Description

@amrmelsayed

What

The codev.telemetry setting in packages/vscode/package.json#contributes.configuration.properties has a description that reads as a factual statement rather than as a description of what the setting controls:

"codev.telemetry": {
  "type": "boolean",
  "default": false,
  "description": "No telemetry collected"
}

What users see

In VS Code's Settings UI (and on the extension's Feature Contributions tab), this renders as:

Codev > Telemetry
No telemetry collected

A user looking at this row thinks "huh, this is just informational?" — it doesn't describe what setting it to true would do, what setting it to false does, or why the toggle exists. The setting defaults to false and is functionally inert (no code paths read it for actual telemetry control today), which makes the cryptic description doubly confusing.

Suggested fix

Reword the description to describe the toggle clearly and reflect the current reality (no telemetry, the setting is a forward-compat placeholder). For example:

"codev.telemetry": {
  "type": "boolean",
  "default": false,
  "description": "Reserved for future use. Codev does not collect telemetry."
}

Or, if a future-tense framing reads better:

"description": "Opt in to anonymous usage telemetry. Currently a no-op — Codev does not collect telemetry."

Keep the setting (don't remove it) for forward-compatibility — future code paths can read it without a breaking schema change.

File to change

  • packages/vscode/package.jsoncontributes.configuration.properties["codev.telemetry"].description.

Acceptance

  • The description, read in isolation, tells a user what the toggle controls and what its current behavior is.

Discovered while

Auditing the VS Code extension's auto-generated Feature Contributions tab during the README revision pass (see docs/vscode-readme-revision branch).

Metadata

Metadata

Assignees

Labels

area/vscodeArea: VS Code extension

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions