Repository navigation
docs: performance rules for contributors - #797
Merged
Merged
Conversation
Contributor
PR Quality ReportCompared against base branch Coverage and tests
Compatibility
Performance smokePerformance smoke was skipped for this PR because no perf-sensitive paths changed. State
|
szibis
added a commit
that referenced
this pull request
Oct 21, 2026
The release workflow could not create the metadata branch for v2.24.1 (it was cut from #794 while main had already moved on). Materialize the published 2.24.1 notes as the [2.24.1] section (#792's CI entry and #794's Security entry, exactly as released) and set the chart to 2.24.1; [Unreleased] keeps the entries merged since (#795, #796, #797). Co-authored-by: szibis <szibis@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This adds a "Performance Rules" section to
CONTRIBUTING.md, stating the performance bar contributions are held to, how the repository measures it, and how to prioritise gaps. Every statement was checked against the measurement code (bench/ab/daily.py,pr_smoke.py,selection.py,perf-ab.yaml,pr-quality-report.yaml,check_quality_gate.py,conformance/reports/performance.md,gaps.md).The section
The bar:
--refresh-s;How it is measured:
mainand Loki, cold and warm p50 per shape and range.cmd/,go.modandgo.sum. It fails on a broken shape, a slowdown confirmed by a re-run, or a new difference from Loki.pr-quality-report, gated bycheck_quality_gate.py;Priority:
Largest gap first, using
performance.md, the daily trend andgaps.md.CHANGELOG: a Documentation entry.
Not applicable: documentation only, so e2e vs Loki, the Grafana range matrix, visual proof, A/B, benchstat and the load test do not apply. Changelog gate ok.