Skip to content

docs: write guide on adding new test suites to circleci #6773

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

Merged
merged 11 commits into from
Aug 29, 2023

Conversation

ericlaz
Copy link
Contributor

@ericlaz ericlaz commented Aug 28, 2023

Motivation

This PR aims to explain how to add new test suites in the contributing docs. This can be highly useful for new contributors as a reference to follow when writing new integrations for dd-trace-py.

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. If no release note is required, add label changelog/no-changelog.
  • Documentation is included (in-code, generated user docs, public corp docs).
  • Backport labels are set (if applicable)

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 has explicitly acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment.
  • Backport labels are set in a manner that is consistent with the release branch maintenance policy
  • If this PR touches code that signs or publishes builds or packages, or handles credentials of any kind, I've requested a review from @DataDog/security-design-and-guidance.
  • This PR doesn't touch any of that.

@ericlaz ericlaz added changelog/no-changelog A changelog entry is not required for this PR. CI App labels Aug 28, 2023
@ericlaz ericlaz marked this pull request as ready for review August 28, 2023 15:52
@ericlaz ericlaz requested a review from a team as a code owner August 28, 2023 15:52
@ericlaz ericlaz requested review from majorgreys and Yun-Kim August 28, 2023 15:52
@emmettbutler emmettbutler self-requested a review August 28, 2023 15:54
Copy link
Collaborator

@emmettbutler emmettbutler left a comment

Choose a reason for hiding this comment

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

This is awesome, thanks for taking the time to think about how to make documentation useful. I suggested a few changes that are pretty minor.

@pr-commenter
Copy link

pr-commenter bot commented Aug 28, 2023

Benchmarks

Benchmark execution time: 2023-08-28 21:04:32

Comparing candidate commit ef399ba in PR branch eric.navarro/update-contributing-docs with baseline commit 056f0a3 in branch 1.x.

Found 1 performance improvements and 0 performance regressions! Performance is the same for 103 metrics, 0 unstable metrics.

scenario:flasksimple-appsec-get

  • 🟩 max_rss_usage [-831.762KB; -693.179KB] or [-2.436%; -2.030%]

@emmettbutler emmettbutler self-requested a review August 28, 2023 17:12
emmettbutler
emmettbutler previously approved these changes Aug 28, 2023
@emmettbutler emmettbutler enabled auto-merge (squash) August 28, 2023 17:37
@emmettbutler emmettbutler self-requested a review August 29, 2023 14:36
@emmettbutler emmettbutler merged commit aeb0191 into 1.x Aug 29, 2023
@emmettbutler emmettbutler deleted the eric.navarro/update-contributing-docs branch August 29, 2023 14:48
@github-actions github-actions bot added this to the v1.19.0 milestone Aug 29, 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. CI App
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants