Sitelet https://github.com/nodejs/node/issues/11190
Skip to content

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

Description

@joyeecheung

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

Activity

  1. added
    docIssues and PRs related to Node.js documentation.
    benchmarkIssues and PRs related to Node.js benchmarks and benchmarking infrastructure.
    on Feb 6, 2017
  2. evanlucas commented on Feb 6, 2017

    @evanlucas
    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)

  3. joyeecheung commented on Feb 7, 2017

    @joyeecheung
    MemberAuthor

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

  4. added a commit that references this issue on Mar 7, 2017
  5. added a commit that references this issue on Mar 9, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    benchmarkIssues and PRs related to Node.js benchmarks and benchmarking infrastructure.docIssues and PRs related to Node.js documentation.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions