Skip to content

docs: document how to run OpenTelemetry contract checks in CONTRIBUTING.md - #107

Open
rajverrr wants to merge 2 commits into
adityareddy-dev:mainfrom
rajverrr:fix/issue-100
Open

rajverrr wants to merge 2 commits into
adityareddy-dev:mainfrom
rajverrr:fix/issue-100

Conversation

@rajverrr

Copy link
Copy Markdown

Resolves #100

Summary of Changes

  • Added npm run test:otel to the primary checks list in CONTRIBUTING.md.
  • Documented what the suite checks: validating the packed package against web SDK setups in fixtures/otel, as well as compiling TypeScript code blocks from docs/opentelemetry.md that start with a // src/... path comment.
  • Added usage examples for npm run test:otel, --fresh, and --tarball.
  • Explained that the suite runs in Node without a browser, uses the fixture lockfile (or resolves latest browser SDKs within the compatible 2.x / 0.2xx family with --fresh), and prints the retained temporary copy's path on failure.
  • Verified with git diff --check.

@adityareddy-dev adityareddy-dev left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Can you wrap the two new paragraphs to match the rest of CONTRIBUTING.md? In the first, I'd use "checks ... and compiles ..." and drop "(no browser required)", since the last paragraph already says it runs without a browser.

The earlier paragraph still calls test:pack and test:vite-app "the two checks" that use the published package. Can you add test:otel there too? It also installs the tarball.

@rajverrr

Copy link
Copy Markdown
Author

Thanks for the feedback!

  • Added npm run test:otel to the earlier paragraph alongside test:pack and test:vite-app as the checks that test against the published package tarball.
  • Updated the first paragraph to use "checks ... and compiles ..." and dropped "(no browser required)".
  • Wrapped both paragraphs to match the line width of the rest of CONTRIBUTING.md.

Pushed the changes in the latest commit.

This branch has not been deployed

No deployments
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.

document how to run the OpenTelemetry contract checks

2 participants