Skip to content

docs: add internal/tracing/ and OpenTelemetry to CONTRIBUTING.md#3288

Merged
lpcox merged 3 commits intomainfrom
copilot/fix-documentation-reconciliation
Apr 6, 2026
Merged

docs: add internal/tracing/ and OpenTelemetry to CONTRIBUTING.md#3288
lpcox merged 3 commits intomainfrom
copilot/fix-documentation-reconciliation

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 6, 2026

CONTRIBUTING.md was missing the internal/tracing/ package entirely and omitted OpenTelemetry from the dependencies list, despite both being present in the codebase.

Changes

  • Project structure tree — added tracing/ entry (alphabetically between timeutil/ and tty/)
  • Key Directories — added internal/tracing/ with description: OpenTelemetry OTLP trace export helpers (HTTP handler wrapping, provider management)
  • Dependencies — added go.opentelemetry.io/otel entry covering OTLP export and span/trace management

Copilot AI linked an issue Apr 6, 2026 that may be closed by this pull request
Copilot AI changed the title [WIP] Fix documentation discrepancies in contributing guidelines docs: add internal/tracing/ and OpenTelemetry to CONTRIBUTING.md Apr 6, 2026
Copilot AI requested a review from lpcox April 6, 2026 15:32
Copilot finished work on behalf of lpcox April 6, 2026 15:32
@lpcox lpcox marked this pull request as ready for review April 6, 2026 15:48
Copilot AI review requested due to automatic review settings April 6, 2026 15:48
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates contributor documentation to reflect the existing internal/tracing/ package and OpenTelemetry usage in the repository, keeping the project structure and dependency references current.

Changes:

  • Added internal/tracing/ to the project structure tree and “Key Directories” list.
  • Added an OpenTelemetry dependency entry to the dependencies list.
Show a summary per file
File Description
CONTRIBUTING.md Documents the internal/tracing/ package and adds OpenTelemetry to the listed dependencies.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 1/1 changed files
  • Comments generated: 1

Comment thread CONTRIBUTING.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@lpcox lpcox merged commit d1ab319 into main Apr 6, 2026
3 checks passed
@lpcox lpcox deleted the copilot/fix-documentation-reconciliation branch April 6, 2026 15:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

📚 Documentation Reconciliation Report - 2026-04-06

3 participants