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

chore(docs): clarify a few things about local testing in the readme #5144

Merged
merged 3 commits into from
Feb 24, 2023

Conversation

emmettbutler
Copy link
Collaborator

@emmettbutler emmettbutler commented Feb 16, 2023

These changes make a few small improvements to the README that would have helped me when I was onboarding.

Checklist

  • Change(s) are motivated and described in the PR description.
  • Testing strategy is described if automated tests are not included in the PR.
  • Risk is outlined (performance impact, potential for breakage, maintainability, etc).
  • Change is maintainable (easy to change, telemetry, documentation).
  • Library release note guidelines are followed.
  • Documentation is included (in-code, generated user docs, public corp docs).
  • Author is aware of the performance implications of this PR as reported in the benchmarks PR comment.

Reviewer Checklist

  • Title is accurate.
  • No unnecessary changes are introduced.
  • Description motivates each change.
  • Avoids breaking API changes unless absolutely necessary.
  • Testing strategy adequately addresses listed risk(s).
  • Change is maintainable (easy to change, telemetry, documentation).
  • Release note makes sense to a user of the library.
  • Reviewer is aware of, and discussed the performance implications of this PR as reported in the benchmarks PR comment.

Yun-Kim
Yun-Kim previously approved these changes Feb 16, 2023
Copy link
Contributor

@Yun-Kim Yun-Kim left a comment

Choose a reason for hiding this comment

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

Actually, this might clarify the fact the testrunner image is internal to this library and does not need to be installed from an external source.

README.md Outdated Show resolved Hide resolved
@pr-commenter
Copy link

pr-commenter bot commented Feb 16, 2023

Benchmarks

Comparing candidate commit 7657b91 in PR branch emmett.butler/riot-readme with baseline commit 4f88161 in branch 1.x.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 56 cases.

@Yun-Kim Yun-Kim added the changelog/no-changelog A changelog entry is not required for this PR. label Feb 16, 2023
@codecov-commenter
Copy link

Codecov Report

Merging #5144 (750db95) into 1.x (bd20c55) will decrease coverage by 0.01%.
The diff coverage is 86.09%.

@@            Coverage Diff             @@
##              1.x    #5144      +/-   ##
==========================================
- Coverage   74.63%   74.63%   -0.01%     
==========================================
  Files         848      848              
  Lines       65636    65705      +69     
==========================================
+ Hits        48988    49037      +49     
- Misses      16648    16668      +20     
Impacted Files Coverage Δ
ddtrace/contrib/asgi/middleware.py 86.30% <77.77%> (-8.70%) ⬇️
ddtrace/contrib/django/patch.py 83.23% <94.11%> (+0.10%) ⬆️
ddtrace/contrib/django/utils.py 92.34% <100.00%> (+0.26%) ⬆️
tests/contrib/django/test_django_snapshots.py 100.00% <100.00%> (ø)
ddtrace/internal/remoteconfig/worker.py 92.30% <0.00%> (-3.85%) ⬇️
ddtrace/contrib/cassandra/session.py 86.09% <0.00%> (-1.07%) ⬇️
ddtrace/appsec/ddwaf/ddwaf_types.py 87.91% <0.00%> (-0.55%) ⬇️
tests/utils.py 90.18% <0.00%> (-0.24%) ⬇️

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

Co-authored-by: Yun Kim <35776586+Yun-Kim@users.noreply.github.com>
@emmettbutler emmettbutler enabled auto-merge (squash) February 24, 2023 18:01
@emmettbutler emmettbutler merged commit 5966e36 into 1.x Feb 24, 2023
@emmettbutler emmettbutler deleted the emmett.butler/riot-readme branch February 24, 2023 18:44
@github-actions github-actions bot added this to the v1.10.0 milestone Feb 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog A changelog entry is not required for this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants