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

Aperta
#205 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
ruby
Ambito
documentation

Direzione di ricerca

Leggi CONTRIBUTING.md e le indicazioni sui benchmark in README.md, quindi confronta gli esempi di denominazione in code/proc-and-block/proc-call-vs-yield.rb. Documenta come i contributori dei benchmark debbano riportare i dettagli della macchina, interpretare l'obiettivo di miglioramento indicato, denominare i metodi di benchmark e determinare chi aggiorna README; il lavoro è completo quando queste domande hanno indicazioni chiare nella documentazione per i contributori.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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
Lingua principale
Ruby
Stelle
5.7k
Fork
370
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di fastruby/fast-ruby

Tutte le issue di fastruby/fast-ruby

Issue simili

Altre issue su Ruby

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.