rust-lang / rust-lang/rustc-perf

Document overall perf process

Open
#932 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-docs C-improvement
Dominant language
Rust
Stars
733
Forks
189
Avg merge
10h 52m
Merged PRs (30d)
43

Description

The perf process is in flux, but that's even more reason to document that latest state of things. We currently only really document the triage process, but the perf management has grown to be more than triage.

I wrote a bit about this on Zulip:

Essentially the perf-regression label is used to indicate that the latest known performance state of the PR is a regression. perf-regression-triaged is the label applied when something has been done to address the performance issue. This can be one of several things:

  • An issue has been created to address the performance issue (linking to the original PR)
  • The author and reviewer have determined that the change in the PR is worth the regression (e.g., a correctness fix - better to be slow and correct than fast and wrong)
  • The regression isn't actually a regression (i.e., there's something wrong with perf.rlo) - this should be accompanied by an issue on rustc-perf
  • Another PR has been opened that fixes the perf regression (with a link)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the existing documentation for the performance triage process and the Zulip guidance quoted in the issue. Document the broader performance-management workflow, including how perf-regression and perf-regression-triaged are resolved and what links or follow-up issues are expected; done means the current process is described beyond triage.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, performance
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.