Fix the arewefastyet desgin documentation #1263
Merged
Conversation
This file contains 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
Signed-off-by: Florent Poinsard <[email protected]>
✅ Deploy Preview for vitess ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
rsajwani
reviewed
Nov 28, 2022
| @@ -10,21 +10,25 @@ With the codebase of Vitess becoming larger and complex changes getting merged, | |||
|
|
|||
| ## Benchmarking Tool | |||
|
|
|||
| To solve the aforementioned issue, we use a tool named arewefastyet that automatically tests the performance of Vitess. The performance are measured through a set of benchmarks divided into two categories: `micro` and `macro`, the former focuses on unit-level functions, and the latter targets system-wide performance changes. Those benchmarks are run every night if there are new commits, release or pull request needing benchmarks. | |||
| To solve the aforementioned issue, we use a tool named arewefastyet that automatically tests the performance of Vitess. The performance are measured through a set of benchmarks divided into two categories: `micro` and `macro`, the former focuses on unit-level functions, and the latter targets system-wide performance changes. | |||
|
|
|||
| The GitHub repository where lies all of arewefastyet's code can be found on [vitessio/arewefastyet](https://github.com/vitessio/arewefastyet). | |||
There was a problem hiding this comment.
fount 'at'/ fount 'here' instead of found 'on'??
| ### Pull Request needing benchmarks | ||
|
|
||
| When a pull request affect the performance of Vitess, one might wish to benchmark it before merging it. The latter can be done by setting the `Benchmark me` label to your pull request. Each night, at midnight central european time, the head commit of your pull request will be benchmarked and compared against the pull request's base. | ||
| When a pull request affect the performance of Vitess, one might wish to benchmark it before merging it. The latter can be done by setting the `Benchmark me` label to your pull request. Following the Pull Request CRON schedule, the head commit of your pull request will be benchmarked and compared against the pull request's base. |
There was a problem hiding this comment.
The latter can be done
This can be done ..
| ### Pull Request needing benchmarks | ||
|
|
||
| When a pull request affect the performance of Vitess, one might wish to benchmark it before merging it. The latter can be done by setting the `Benchmark me` label to your pull request. Each night, at midnight central european time, the head commit of your pull request will be benchmarked and compared against the pull request's base. | ||
| When a pull request affect the performance of Vitess, one might wish to benchmark it before merging it. The latter can be done by setting the `Benchmark me` label to your pull request. Following the Pull Request CRON schedule, the head commit of your pull request will be benchmarked and compared against the pull request's base. |
There was a problem hiding this comment.
trying to understand , what is meant by 'Following the Pull Request CRON schedule' ,
is it
'after the PR, the subsequent scheduled call for CRON job will benchmark the head commit of pull request and compare it against the pull request's base.
|
@rsajwani I opened a new PR to adresse your comments. |
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.
This PR fixes #1260. And is part of the parent issue: #1222