Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add custom tests instructions for specific packages. #5046

Closed
Annosha opened this issue Oct 7, 2024 · 1 comment · Fixed by #5056
Closed

Add custom tests instructions for specific packages. #5046

Annosha opened this issue Oct 7, 2024 · 1 comment · Fixed by #5056
Labels
document Documentation-related

Comments

@Annosha
Copy link
Contributor

Annosha commented Oct 7, 2024

I was going through the packages individually for the opentelemetry-js repo. Compiled and ran test. Some packages:
Opentelemetry-context-zone have custom test scripts i.e. "test:browser": "karma start --single-run",.
Do we need to add this information about running custom test script for beginners in README.md?

Likewise, for following repositories:
opentelemetry-context-zone-peer-dep
opentelemetry-sdk-trace-web
@pichlermarc

@pichlermarc
Copy link
Member

@Annosha I think this can be helpful. If needed it should only go into the top-level CONTRIBUTING.md though.

It may be good to add the info that this test script exists if the package is also expected to run in the browser. It only runs browser-specific tests and tests that are shared between browser and Node.js

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
document Documentation-related
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants