Node: Move benchmark/README.md to doc/guide

Created on 6 Feb 2017  路  2Comments  路  Source: nodejs/node

The current benchmark/README.md is in fact a guide on how to run and write benchmarks, I suggest we move this to doc/guides (where writing-tests.md is) and create another README.md that explains the directory layout/common API (like what test/README.md does).

cc @nodejs/collaborators

benchmark doc

Most helpful comment

I think it makes sense to have a README that explains how to run the benchmarks in the benchmarks directory, but I do think that the guide on how to write one should be in guides (linked from the readme)

All 2 comments

I think it makes sense to have a README that explains how to run the benchmarks in the benchmarks directory, but I do think that the guide on how to write one should be in guides (linked from the readme)

I think it makes sense to have a README that explains how to run the benchmarks in the benchmarks directory, but I do think that the guide on how to write one should be in guides (linked from the readme)

I agree, the same can be done to test/README.md too. I'll prepare a PR for that :)

Was this page helpful?
0 / 5 - 0 ratings

Related issues

filipesilvaa picture filipesilvaa  路  3Comments

jmichae3 picture jmichae3  路  3Comments

stevenvachon picture stevenvachon  路  3Comments

mcollina picture mcollina  路  3Comments

seishun picture seishun  路  3Comments