Skip to content

chore: Add performance test/results requirement for perf PRs in PR template#10390

Merged
mgallien merged 2 commits into
masterfrom
chore/perf-pr-template
Jul 20, 2026
Merged

chore: Add performance test/results requirement for perf PRs in PR template#10390
mgallien merged 2 commits into
masterfrom
chore/perf-pr-template

Conversation

@claucambra

Copy link
Copy Markdown
Collaborator

Summary

Should prevent a codeowner having to re-request this in PRs missing tests

Checklist

AI (if applicable)

@claucambra claucambra added this to the 34.0.0 milestone Jul 16, 2026
@claucambra claucambra self-assigned this Jul 16, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.md describing 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.

Comment thread AGENTS.md
Comment on lines +128 to +131
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.
@mgallien
mgallien enabled auto-merge July 20, 2026 07:12
…mplate

Signed-off-by: Claudio Cambra <developer@claudiocambra.com>
Signed-off-by: Claudio Cambra <developer@claudiocambra.com>
@mgallien
mgallien force-pushed the chore/perf-pr-template branch from 2b09174 to 3181718 Compare July 20, 2026 07:13
@github-actions

Copy link
Copy Markdown
Contributor

Artifact containing the AppImage: nextcloud-appimage-pr-10390.zip

Digest: sha256:277c09250b65a415b812862c813efde045aaff2d4d1e4540703bc92b29b860a8

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.

@sonarqubecloud

Copy link
Copy Markdown

@mgallien
mgallien merged commit a7fe673 into master Jul 20, 2026
22 of 23 checks passed
@mgallien
mgallien deleted the chore/perf-pr-template branch July 20, 2026 08:04
@mgallien

Copy link
Copy Markdown
Collaborator

/backport to stable-34.0 please

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.

5 participants