-
Notifications
You must be signed in to change notification settings - Fork 14
Added execution and updated installation section to Readme #175
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Hi @filipecosta90, could you please take a look? I've added execution section and slightly updated installation section. By the way, I see 2 installation sections - in start of readme and below (which I updated). Should they be combined to 1? |
Codecov ReportBase: 59.35% // Head: 59.35% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## main #175 +/- ##
=======================================
Coverage 59.35% 59.35%
=======================================
Files 24 24
Lines 1811 1811
=======================================
Hits 1075 1075
Misses 736 736 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maria, you are right that there are 2 "Installation" section. I would agree that we should probably keep 1 of them. I would say the second one.
Then , notice that there are 2 ways to execute this. We have the coordinator and we have the standalone runner.
I think that you could add your execution section before the section: Testing out redis-benchmarks-spec-sc-coordinator
You could name it: Testing out the redis-benchmarks-spec-runner ...
And explain the difference.
abc4e45
to
3ff4ed8
Compare
3ff4ed8
to
d4da262
Compare
Hi @slice4e, I removed one extra Installation section. I moved Execution to Contribution part. As it has installation dependencies, I moved Installation section to Contribution part too. Honestly I slightly confused that Installation and Execution (testing out) is presented in Contribution part only. What if I don't want to add new benchmarks, but want to see Redis pass rate on benchmarks-specification? O_o Also I added Navigation in top of page for easy usage. |
Hi @slice4e , @filipecosta90 , could you please look at CI falures? Seems like there is some connection issue, running tox from Readme locally gives me the same problem. How may I fix it? |
Readme.md
Outdated
- [Adding a continuous benchmark platform](#adding-a-continuous-benchmark-platform) | ||
- [Installing package requirements](#installing-package-requirements) | ||
- [Installing Redis benchmarks specification](#installing-redis-benchmarks-specification-implementations) | ||
- [Testing out the redis-benchmarks-spec-runner](#testing-out-the-redis-benchmarks-spec-runner) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
rename it to> redis-benchmarks-spec-client-runner
Thank you @markovamaria . Approving! |
Related-to:
#105
#104