Add more comprehensive documentation on testing and benchmarking to CONTRIBUTING.md #5478
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
tustvold
approved these changes
Mar 6, 2024
| @@ -134,6 +155,21 @@ Search for `allow(clippy::` in the codebase to identify lints that are ignored/a | |||
| - If you have several lints on a function or module, you may disable the lint on the function or module. | |||
| - If a lint is pervasive across multiple modules, you may disable it at the crate level. | |||
|
|
|||
| ## Running Benchmarks | |||
There was a problem hiding this comment.
You could also mention the ability to do
git checkout master
cargo bench --bench parse_time -- --save-baseline master
git checkout feature
cargo bench --bench parse_time -- --baseline master
There was a problem hiding this comment.
Thanks! Just added that.
|
Thanks again |
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.
Which issue does this PR close?
This does not address an issue.
Rationale for this change
This change will hopefully help new contributors run more comprehensive tests and benchmarks.
What changes are included in this PR?
This PR adds additional testing and benchmarking examples to CONTRIBUTING.md.
Are there any user-facing changes?
No, this PR does not change any code.