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

docs: enhanced description for instrumentations in package.json #2202

Merged
merged 2 commits into from
May 18, 2024

Conversation

blumamir
Copy link
Member

There seem to be a lot of variations on what instrumentation packages populate in the "description" field of "package.json". This PR aims to align them all to one format, and rephrase them to be more useful to consume (in my opinion).

Previous texts where trivial, too long, and did not explain well enough the target for each instrumentation. I tried to include a short description on what this instrumentation targets in few words. Please share any improvements suggestions to the texts.

I also added a short section to the GUIDELINES to document to the future us, how this text is recommended to be formatted.

Copy link

codecov bot commented May 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.37%. Comparing base (dfb2dff) to head (8a3a92b).
Report is 128 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2202      +/-   ##
==========================================
- Coverage   90.97%   90.37%   -0.61%     
==========================================
  Files         146      147       +1     
  Lines        7492     7502      +10     
  Branches     1502     1571      +69     
==========================================
- Hits         6816     6780      -36     
- Misses        676      722      +46     

see 43 files with indirect coverage changes

Copy link
Contributor

@trentm trentm left a comment

Choose a reason for hiding this comment

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

Thanks for doing this.
All nits below.

GUIDELINES.md Outdated Show resolved Hide resolved
plugins/node/instrumentation-cucumber/package.json Outdated Show resolved Hide resolved
plugins/node/instrumentation-fs/package.json Outdated Show resolved Hide resolved
@blumamir
Copy link
Member Author

Thank you @trentm great suggestions. addressed everything

Copy link
Member

@JamieDanielson JamieDanielson left a comment

Choose a reason for hiding this comment

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

A few more nits from my end as well, but generally I love this change!

GUIDELINES.md Outdated Show resolved Hide resolved
GUIDELINES.md Outdated Show resolved Hide resolved
plugins/node/instrumentation-fs/package.json Outdated Show resolved Hide resolved
plugins/node/instrumentation-mongoose/package.json Outdated Show resolved Hide resolved
GUIDELINES.md Outdated Show resolved Hide resolved
Copy link

linux-foundation-easycla bot commented May 17, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

@blumamir blumamir force-pushed the inst-description branch from a863673 to deed22f Compare May 17, 2024 08:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.