Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Move benchmark/README.md to doc/guide #11190

Closed
joyeecheung opened this issue Feb 6, 2017 · 2 comments
Closed

Move benchmark/README.md to doc/guide #11190

joyeecheung opened this issue Feb 6, 2017 · 2 comments
Labels
benchmark Issues and PRs related to the benchmark subsystem. doc Issues and PRs related to the documentations.

Comments

@joyeecheung
Copy link
Member

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
@joyeecheung joyeecheung added doc Issues and PRs related to the documentations. benchmark Issues and PRs related to the benchmark subsystem. labels Feb 6, 2017
@evanlucas
Copy link
Contributor

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)

@joyeecheung
Copy link
Member Author

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 :)

@joyeecheung joyeecheung mentioned this issue Feb 8, 2017
Closed
3 tasks
joyeecheung added a commit that referenced this issue Feb 17, 2017
@joyeecheung
doc: add benchmark/README.md and fix guide
8926f11 
* Write a new benchmark/README.md describing the benchmark
  directory layout and common API.
* Fix the moved benchmarking guide accordingly, add tips about how
  to get the help text from the benchmarking tools.

PR-URL: #11237
Fixes: #11190
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Andreas Madsen <amwebdk@gmail.com>
joyeecheung added a commit that referenced this issue Feb 17, 2017
@joyeecheung
doc: improve test/README.md
736814e 
* Add description about the test directory
* Add link to the test writing guide and the contributing guide
* Use table to describe the directory layout and CI info

PR-URL: #11237
Fixes: #11190
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Andreas Madsen <amwebdk@gmail.com>
addaleax pushed a commit that referenced this issue Feb 22, 2017
@joyeecheung @addaleax
doc: move benchmark/README.md to doc/guides
22a6edd 
Since benchmark/README.md is in fact a guide on how to
write and run benchmarks, move it to doc/guides.

PR-URL: #11237
Fixes: #11190
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Andreas Madsen <amwebdk@gmail.com>
addaleax pushed a commit that referenced this issue Feb 22, 2017
@joyeecheung @addaleax
doc: add benchmark/README.md and fix guide
5d12fd9 
* Write a new benchmark/README.md describing the benchmark
  directory layout and common API.
* Fix the moved benchmarking guide accordingly, add tips about how
  to get the help text from the benchmarking tools.

PR-URL: #11237
Fixes: #11190
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Andreas Madsen <amwebdk@gmail.com>
addaleax pushed a commit that referenced this issue Feb 22, 2017
@joyeecheung @addaleax
doc: improve test/README.md
66f9506 
* Add description about the test directory
* Add link to the test writing guide and the contributing guide
* Use table to describe the directory layout and CI info

PR-URL: #11237
Fixes: #11190
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Andreas Madsen <amwebdk@gmail.com>
jasnell pushed a commit that referenced this issue Mar 7, 2017
@joyeecheung @jasnell
doc: improve test/README.md
5f1b9a4 
* Add description about the test directory
* Add link to the test writing guide and the contributing guide
* Use table to describe the directory layout and CI info

PR-URL: #11237
Fixes: #11190
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Andreas Madsen <amwebdk@gmail.com>
MylesBorins pushed a commit that referenced this issue Mar 9, 2017
@joyeecheung @MylesBorins
doc: improve test/README.md
0164d92 
* Add description about the test directory
* Add link to the test writing guide and the contributing guide
* Use table to describe the directory layout and CI info

PR-URL: #11237
Fixes: #11190
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Andreas Madsen <amwebdk@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
benchmark Issues and PRs related to the benchmark subsystem. doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@evanlucas @joyeecheung