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): readme.md and contributing doc updates #5426

Merged
merged 2 commits into from
Apr 4, 2023

Conversation

tabgok
Copy link
Contributor

@tabgok tabgok commented Mar 29, 2023

This commit contains two small changes to documentation:

  1. Adds a WARNING message for installing git pre-commit hooks and instructions on how to uninstall.
  2. Updates the link to the integration checklist template in the contributing to integrations document

Testing Strategy: N/A
Risks: None

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.

@tabgok tabgok requested review from a team as code owners March 29, 2023 02:38
@tabgok tabgok requested review from emmettbutler and mabdinur March 29, 2023 02:38
@pr-commenter
Copy link

pr-commenter bot commented Mar 29, 2023

Benchmarks

Comparing candidate commit bea7ece in PR branch teague.bick-update-readme-githooks with baseline commit 883f685 in branch 1.x.

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

@codecov-commenter
Copy link

codecov-commenter commented Mar 29, 2023

Codecov Report

Merging #5426 (91356bf) into 1.x (35ab4b7) will decrease coverage by 0.04%.
The diff coverage is 72.39%.

@@            Coverage Diff             @@
##              1.x    #5426      +/-   ##
==========================================
- Coverage   76.66%   76.62%   -0.04%     
==========================================
  Files         909      910       +1     
  Lines       71308    71563     +255     
==========================================
+ Hits        54667    54836     +169     
- Misses      16641    16727      +86     
Impacted Files Coverage Δ
ddtrace/internal/constants.py 0.00% <0.00%> (ø)
ddtrace/internal/encoding.py 46.91% <ø> (ø)
tests/appsec/iast/test_weak_hash.py 100.00% <ø> (ø)
tests/utils.py 90.27% <ø> (-0.24%) ⬇️
tests/tracer/test_writer.py 96.85% <20.00%> (-2.90%) ⬇️
tests/tracer/test_span.py 97.36% <33.33%> (-1.29%) ⬇️
ddtrace/contrib/aws_lambda/patch.py 78.33% <45.45%> (-6.86%) ⬇️
ddtrace/appsec/iast/taint_sinks/sql_injection.py 78.57% <50.00%> (-21.43%) ⬇️
ddtrace/contrib/aiohttp/patch.py 92.68% <50.00%> (-1.07%) ⬇️
ddtrace/internal/processor/trace.py 58.08% <50.00%> (-0.38%) ⬇️
... and 20 more

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

@tabgok tabgok force-pushed the teague.bick-update-readme-githooks branch from 4ba4e41 to 80f19fa Compare March 29, 2023 12:31
emmettbutler
emmettbutler previously approved these changes Mar 29, 2023
@emmettbutler
Copy link
Collaborator

@tabgok adding the changelog/no-changelog label to this PR will make the "validate changelog" CI step pass.

@tabgok tabgok added the changelog/no-changelog A changelog entry is not required for this PR. label Mar 29, 2023
mabdinur
mabdinur previously approved these changes Mar 29, 2023
@tabgok tabgok changed the title chore(docs): README.md and Contributing doc updates chore(docs): readme.md and contributing doc updates Mar 29, 2023
@tabgok tabgok dismissed stale reviews from mabdinur and emmettbutler via fe74eb6 March 29, 2023 17:33
@tabgok tabgok force-pushed the teague.bick-update-readme-githooks branch 3 times, most recently from 91356bf to dc60f6d Compare March 31, 2023 20:03
Copy link
Contributor

@majorgreys majorgreys left a comment

Choose a reason for hiding this comment

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

Can we open a bug report for this?

README.md Outdated Show resolved Hide resolved
@tabgok tabgok force-pushed the teague.bick-update-readme-githooks branch 2 times, most recently from cd5f9e5 to ad7a7a4 Compare April 3, 2023 16:49
@tabgok tabgok requested review from a team as code owners April 4, 2023 14:14
@tabgok tabgok self-assigned this Apr 4, 2023
@tabgok tabgok force-pushed the teague.bick-update-readme-githooks branch 2 times, most recently from 9daeeea to e6e48a1 Compare April 4, 2023 15:04
Yun-Kim
Yun-Kim previously approved these changes Apr 4, 2023
@Yun-Kim Yun-Kim force-pushed the teague.bick-update-readme-githooks branch from e94fb62 to 4de6253 Compare April 4, 2023 20:03
@Yun-Kim
Copy link
Contributor

Yun-Kim commented Apr 4, 2023

Hi @tabgok, I've squashed your commits and signed them so that we can merge. Thanks for your contribution!

@Yun-Kim Yun-Kim enabled auto-merge (squash) April 4, 2023 20:13
@Yun-Kim Yun-Kim merged commit d359ef8 into 1.x Apr 4, 2023
@Yun-Kim Yun-Kim deleted the teague.bick-update-readme-githooks branch April 4, 2023 20:28
@github-actions github-actions bot added this to the v1.12.0 milestone Apr 4, 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.

6 participants