[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

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
ruby
Lĩnh vực
documentation

Hướng nghiên cứu

Đọc CONTRIBUTING.md và hướng dẫn về benchmark trong README.md, sau đó so sánh các ví dụ đặt tên trong code/proc-and-block/proc-call-vs-yield.rb. Ghi lại cách những người đóng góp benchmark phải báo cáo thông tin chi tiết về máy, diễn giải mục tiêu cải thiện được nêu, đặt tên cho các phương thức benchmark và xác định ai cập nhật README; công việc được xem là hoàn thành khi tài liệu dành cho người đóng góp có hướng dẫn rõ ràng cho những câu hỏi này.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Suggestion

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
Ngôn ngữ chính
Ruby
Star
5.7k
Fork
370
Không có pull request nào được merge trong 30 ngày

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

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

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của fastruby/fast-ruby

Tất cả issue của fastruby/fast-ruby

Issue tương tự

Thêm issue về Ruby

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.