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

📝 [RUMF-1526] simplify rum package README.md #2122

Merged
merged 2 commits into from
Mar 29, 2023

Conversation

bcaudan
Copy link
Contributor

@bcaudan bcaudan commented Mar 29, 2023

Motivation

With the migration of logs and RUM documentations to the documentation repository, simplify the rum package README.md to avoid to duplications

Changes

Intent:

  • small description + redirect to official doc
  • document a simple usage

Focus on npm setup only since this README.ms is used as the rum package main page

Testing

  • Local
  • Staging
  • Unit
  • End to end

I have gone over the contributing documentation.

@bcaudan bcaudan requested review from a team as code owners March 29, 2023 12:33
Copy link
Contributor

@hestonhoffman hestonhoffman left a comment

Choose a reason for hiding this comment

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

One tiny edit, but otherwise LGTM! :shipit:

packages/rum/README.md Outdated Show resolved Hide resolved
Co-authored-by: Heston Hoffman <[email protected]>
@codecov-commenter
Copy link

Codecov Report

Merging #2122 (8d3f931) into main (5578fe2) will decrease coverage by 0.09%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #2122      +/-   ##
==========================================
- Coverage   93.75%   93.67%   -0.09%     
==========================================
  Files         174      174              
  Lines        5961     5961              
  Branches     1338     1338              
==========================================
- Hits         5589     5584       -5     
- Misses        372      377       +5     

see 1 file with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@bcaudan bcaudan merged commit be28702 into main Mar 29, 2023
@bcaudan bcaudan deleted the bcaudan/simplify-rum-readme branch March 29, 2023 16:02
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.

5 participants