Skip to content

Add 'Clean Code' and 'C++ Code Style' sections to the 'Conventions' document - #349

Open
xlamorlette-datadog wants to merge 4 commits into
mainfrom
xlamorlette/improve-code-conventions
Open

Add 'Clean Code' and 'C++ Code Style' sections to the 'Conventions' document#349
xlamorlette-datadog wants to merge 4 commits into
mainfrom
xlamorlette/improve-code-conventions

Conversation

@xlamorlette-datadog

@xlamorlette-datadog xlamorlette-datadog commented Aug 5, 2026

Copy link
Copy Markdown
Collaborator

Description

  • Extend the docs/conventions.md documentation file with two sections: 'Clean Code' and 'C++ Code Style'.
  • By the way, clean and improve this file.
  • Add a minimal AGENTS.md file.

Motivation

This 'Datadog C++ Tracer Conventions' documentation is to be used by both human and coding agents ;-)

Additional Notes

Jira ticket: IDMPL-670 C++ Tracer: Improve code conventions in the dedicated documentation in the repository

@pr-commenter

pr-commenter Bot commented Aug 5, 2026

Copy link
Copy Markdown

Benchmarks

Benchmark execution time: 2026-08-06 09:05:59

Comparing candidate commit 4dd3ee0 in PR branch xlamorlette/improve-code-conventions with baseline commit a88d6cd in branch main.

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

Explanation

This is an A/B test comparing a candidate commit's performance against that of a baseline commit. Performance changes are noted in the tables below as:

  • 🟩 = significantly better candidate vs. baseline
  • 🟥 = significantly worse candidate vs. baseline

We compute a confidence interval (CI) over the relative difference of means between metrics from the candidate and baseline commits, considering the baseline as the reference.

If the CI is entirely outside the configured SIGNIFICANT_IMPACT_THRESHOLD (or the deprecated UNCONFIDENCE_THRESHOLD), the change is considered significant.

Feel free to reach out to #apm-benchmarking-platform on Slack if you have any questions.

More details about the CI and significant changes

You can imagine this CI as a range of values that is likely to contain the true difference of means between the candidate and baseline commits.

CIs of the difference of means are often centered around 0%, because often changes are not that big:

---------------------------------(------|---^--------)-------------------------------->
                              -0.6%    0%  0.3%     +1.2%
                                 |          |        |
         lower bound of the CI --'          |        |
sample mean (center of the CI) -------------'        |
         upper bound of the CI ----------------------'

As described above, a change is considered significant if the CI is entirely outside the configured SIGNIFICANT_IMPACT_THRESHOLD (or the deprecated UNCONFIDENCE_THRESHOLD).

For instance, for an execution time metric, this confidence interval indicates a significantly worse performance:

----------------------------------------|---------|---(---------^---------)---------->
                                       0%        1%  1.3%      2.2%      3.1%
                                                  |   |         |         |
       significant impact threshold --------------'   |         |         |
                      lower bound of CI --------------'         |         |
       sample mean (center of the CI) --------------------------'         |
                      upper bound of CI ----------------------------------'

@datadog-official

datadog-official Bot commented Aug 5, 2026

Copy link
Copy Markdown

🎯 Code Coverage (details)
Patch Coverage: 100.00%
Overall Coverage: 91.75% (+0.00%)

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 4dd3ee0 | Docs | Datadog PR Page | Give us feedback!

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.

2 participants