fastruby / fastruby/fast-ruby

[DOCUMENTATION] It's not 100% clear how to contribute new benchmarks

Đang mở
#205 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
Suggestion
Ngôn ngữ chính
Ruby
Star
5.7k
Fork
371
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

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 `fast` and `slow` (and even `slow2`, `slow3` https://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 called `slowX`), I think it could be described better in the CONTRIBUTING file if that's actually the case

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.