1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00

[ci skip] Add benchmark your code section to contributing to ruby on rails guide.

I have seen many times that maintainers want people to use this gem to give
a benchmark report. It would be nice to add it and refer to it later.
This commit is contained in:
Juanito Fatas 2014-05-27 05:14:12 +08:00
parent de8c41cea2
commit 8b39eca5b7

View file

@ -215,6 +215,36 @@ Rails follows a simple set of coding style conventions:
The above are guidelines - please use your best judgment in using them.
### Benchmark Your Code
If your change has an impact on the performance of Rails, please use the
[benchmark-ips](https://github.com/evanphx/benchmark-ips) gem to provide
benchmark results for comparison.
Here's an example of using benchmark-ips:
```ruby
require 'benchmark/ips'
Benchmark.ips do |x|
x.report('addition') { 1 + 2 }
x.report('addition with send') { 1.send(:+, 2) }
end
```
This will generate a report with the following information:
```
Calculating -------------------------------------
addition 69114 i/100ms
addition with send 64062 i/100ms
-------------------------------------------------
addition 5307644.4 (±3.5%) i/s - 26539776 in 5.007219s
addition with send 3702897.9 (±3.5%) i/s - 18513918 in 5.006723s
```
Please see the benchmark/ips [README](https://github.com/evanphx/benchmark-ips/blob/master/README.md) for more information.
### Running Tests
It is not customary in Rails to run the full test suite before pushing