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

Clarify change log section instructions for contributors. #4021

Merged
merged 1 commit into from
Oct 24, 2024

Conversation

p-datadog
Copy link
Member

What does this PR do?
This PR clarifies change log section instructions for contributors.

Namely, contributors can skip the change log section and it will be filled out during PR review.

Also moved the change log section below explanation of changes which should make the template easier to fill out for contributors, and comment out the review request note since it doesn't need to be part of PR text.

Motivation:
Feedback in #4005

Namely, contributors can skip the change log section and it will
be filled out during PR review.

Also moved the change log section below explanation of changes
which should make the template easier to fill out for contributors,
and comment out the review request note since it doesn't need to
be part of PR text.
@p-datadog p-datadog force-pushed the pr-template-changelog branch from fb0b017 to 9e5fccd Compare October 23, 2024 14:11
@p-datadog p-datadog added the dev/internal Other internal work that does not need to be included in the changelog label Oct 23, 2024
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.84%. Comparing base (f8d7b5e) to head (9e5fccd).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4021      +/-   ##
==========================================
- Coverage   97.86%   97.84%   -0.02%     
==========================================
  Files        1319     1319              
  Lines       79157    79157              
  Branches     3929     3929              
==========================================
- Hits        77466    77452      -14     
- Misses       1691     1705      +14     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@pr-commenter
Copy link

pr-commenter bot commented Oct 23, 2024

Benchmarks

Benchmark execution time: 2024-10-23 15:48:14

Comparing candidate commit 9e5fccd in PR branch pr-template-changelog with baseline commit f8d7b5e in branch master.

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

scenario:profiler - gvl benchmark samples

  • 🟩 throughput [+637.482op/s; +645.732op/s] or [+5.784%; +5.859%]

scenario:tracing - Propagation - Trace Context

  • 🟩 throughput [+3105.381op/s; +3222.337op/s] or [+8.999%; +9.338%]

Copy link
Member

@ivoanjo ivoanjo left a comment

Choose a reason for hiding this comment

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

👍 LGTM

Thanks for this! I think small things do add up to making contributors feel welcome ;)

@p-datadog p-datadog merged commit 06e050b into master Oct 24, 2024
269 of 270 checks passed
@p-datadog p-datadog deleted the pr-template-changelog branch October 24, 2024 14:01
@github-actions github-actions bot added this to the 2.5.0 milestone Oct 24, 2024
p-datadog pushed a commit to p-datadog/dd-trace-rb that referenced this pull request Oct 24, 2024
* master: (34 commits)
  Clarify change log section instructions for contributors. (DataDog#4021)
  Minor: Split heap recorder stats into young/non-young
  Minor: Align `heap_clean_after_gc_enabled` native default value with actual default
  Add test coverage for minimum period between heap updates
  Add test coverage for not updating heap half-way during serialization
  Add benchmarking variant for heap with clean after GC
  Remove "only-profiling-alloc-ddprof" testing configuration
  Introduce setting to control heap clean after GC
  Convert `StackRecorder._native_initialize` to use kw args
  Introduce `StackRecorder.for_testing` helper
  Add unit test for heap cleanup after GC only testing young objects
  Add integration-style spec for heap cleanup after GC
  Fix segfaults when calling `_native_debug_heap_recorder` in tests
  Add TODO on metrics to discuss with @AlexJF
  Optimization: Skip updating object sizes when not doing a full update
  Minor: Tweak exception error message
  Hide `heap_recorder_update` from heap recorder API
  Simplify `heap_recorder_update` logic now that `full_update` decision comes from outside
  Remove `last_update_major_gc_since` as it was not working
  Continue refactoring heap cleanup after GC to be best-effort
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev/internal Other internal work that does not need to be included in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants