chore: Add performance test/results requirement for perf PRs in PR template#10390
Conversation
b8f7d90 to
2b09174
Compare
There was a problem hiding this comment.
Pull request overview
This PR updates contributor/agent guidance to require evidence for performance claims, and adds a corresponding checklist item to the pull request template to prompt benchmark coverage and reporting.
Changes:
- Adds a “Performance Optimisations” section to
AGENTS.mddescribing expectations for benchmarking and evidence when presenting performance improvements. - Adds a PR template checklist item requiring tests plus before/after results for performance-related changes.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
AGENTS.md |
Introduces written policy for substantiating performance optimization claims with benchmarks and in-branch evidence. |
.github/pull_request_template.md |
Adds a checklist item prompting benchmark/tests and before/after results for performance improvements. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| A change may be presented as a performance optimisation only if **both** of the following are true: | ||
|
|
||
| - **It is covered by a benchmark test.** A test exercising the optimised code path on a realistic workload must be added to the branch and run before and after the change. This same test must both verify the before/after improvement and reproduce it to catch regressions. The measured numbers - metric, workload, and variance - must be reported honestly, including when the improvement is within noise or only appears in an edge case. | ||
| - **The evidence ships in the working branch.** The benchmark test must live in the PR branch, alongside the optimisation. Evidence that exists only outside the branch or only in the PR description does not satisfy this requirement. |
| - [How to rebase your commits](https://docs.github.com/en/get-started/using-git/about-git-rebase) | ||
| - [How to squash commits with rebase](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History#_squashing) | ||
| - [ ] Uploaded screenshots from before and after for UI changes. | ||
| - [ ] Test(s) added to branch, with before/after results included in PR description, for performance improvements where applicable. |
…mplate Signed-off-by: Claudio Cambra <developer@claudiocambra.com>
Signed-off-by: Claudio Cambra <developer@claudiocambra.com>
2b09174 to
3181718
Compare
|
Artifact containing the AppImage: nextcloud-appimage-pr-10390.zip Digest: To test this change/fix you can download the above artifact file, unzip it, and run it. Please make sure to quit your existing Nextcloud app and backup your data. |
|
|
/backport to stable-34.0 please |



Summary
Should prevent a codeowner having to re-request this in PRs missing tests
Checklist
AI (if applicable)