[DOCUMENTATION] It's not 100% clear how to contribute new benchmarks
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- ruby
调研方向
阅读 CONTRIBUTING.md 和 README.md 中的基准测试指南，然后比较 code/proc-and-block/proc-call-vs-yield.rb 中的命名示例。记录基准测试贡献者应如何报告机器详细信息、如何解释所述的改进目标、如何命名基准测试方法，以及如何确定由谁更新 README；当贡献者文档对这些问题都有明确指导时，即视为完成。
由索引模型根据 Issue 内容生成。
描述
There's this CONTRIBUTING file with some details https://github.com/fastruby/fast-ruby/blob/master/CONTRIBUTING.md
But I still have questions that I think it's worth documenting:
- The README says
All results listed in README.md are running with Ruby 2.2.0p0 on OS X 10.10.1. Machine information: MacBook Pro (Retina, 15-inch, Mid 2014), 2.5 GHz Intel Core i7, 16 GB 1600 MHz DDR3. Your results may vary, but you get the idea. : )so it's not clear how and who should update the readme, maybe that should be removed from there and added for each benchmark so people adding benchmarks can add their specs? - It's not clear what to do with the Goal described in the Contributing file (for example, it says
At least 12% improvement, does it mean that a benchmark showing less than that improvement is not accepted / useful?) - I see code that has methods named
fastandslow(and evenslow2,slow3https://github.com/fastruby/fast-ruby/blob/master/code/proc-and-block/proc-call-vs-yield.rb), I don't think that's the expectation (it makes things harder to read when multiple methods are calledslowX), I think it could be described better in the CONTRIBUTING file if that's actually the case
- 主要语言
- Ruby
- 星标
- 5.7k
- 派生
- 370
- PR 合并指标
- 30 天内没有已合并 PR
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
fastruby/fast-ruby 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 52/100
-
难度 4/5 3-5 天 新手友好度 32/100
-
难度 3/5 1-2 天 新手友好度 35/100
-
难度 2/5 1-3 小时 新手友好度 45/100
-
难度 4/5 3-5 天 新手友好度 42/100
查看 fastruby/fast-ruby 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 70/100
-
bug
难度 1/5 1 小时以内 新手友好度 90/100
riscv/riscv-unified-db#2626 ·
-
Component: GLib
难度 2/5 1-3 小时 新手友好度 70/100
-
ds-drift
难度 2/5 1-3 小时 新手友好度 70/100
we-promise/sure#3693 ·
-
难度 2/5 1-3 小时 新手友好度 75/100
simp/pupmod-simp-simp#395 ·