[Documentation] Could more explanations be added?
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 32/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- ruby
- Domain
- documentation, performance
Research direction
Start by browsing the repository's benchmark entries, especially their "conclusion" sections, and compare their explanations with the LFS/BLFS project referenced in the issue. Done means adding concise, understandable explanations of what most benchmark results mean and why they matter; the issue does not identify specific files or tests.
Written by the indexing model from the issue text.
Description
Hey there,
You lot provide tons of benchmarks. This is nice. But often I don't know what this really
means. Would it be possible to add one or two sentences to most benchmarks out
there? In particular "conclusion" - this would help understand the situation better.
This does not have to be long, as said, a sentence of regular length should suffice for
most. Right now there is very little documentation and explanation, so people have
a hard time learning the "why"'s. See the LFS/BLFS project in how to explain things
so normal people can understand stuff better.
- Dominant language
- Ruby
- Stars
- 5.7k
- Forks
- 370
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from fastruby/fast-ruby
-
Difficulty 2/5 1-3 hours Newbie friendliness 52/100
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
-
Difficulty 4/5 3-5 days Newbie friendliness 42/100
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
All issues in fastruby/fast-ruby
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
TheOdinProject/curriculum#31408 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
bensheldon/good_job#1816 · 5 comments ·